#include <MappingGeneral.h>

Inheritance diagram for Nektar::GlobalMapping::MappingGeneral:

Static Public Member Functions
static GLOBAL_MAPPING_EXPORT MappingSharedPtr	create (const LibUtilities::SessionReaderSharedPtr &pSession, const Array< OneD, MultiRegions::ExpListSharedPtr > &pFields, const TiXmlElement *pMapping)
	Creates an instance of this class. More...

Static Public Member Functions inherited from Nektar::GlobalMapping::Mapping
static GLOBAL_MAPPING_EXPORT MappingSharedPtr	Load (const LibUtilities::SessionReaderSharedPtr &pSession, const Array< OneD, MultiRegions::ExpListSharedPtr > &pFields)
	Return a pointer to the mapping, creating it on first call. More...

Static Public Attributes
static std::string	className
	Name of the class. More...

Protected Member Functions
void	CalculateMetricTerms ()

void	CalculateChristoffel ()

	MappingGeneral (const LibUtilities::SessionReaderSharedPtr &pSession, const Array< OneD, MultiRegions::ExpListSharedPtr > &pFields)

GLOBAL_MAPPING_EXPORT void	v_InitObject (const Array< OneD, MultiRegions::ExpListSharedPtr > &pFields, const TiXmlElement *pMapping) override

GLOBAL_MAPPING_EXPORT void	v_ContravarToCartesian (const Array< OneD, Array< OneD, NekDouble > > &inarray, Array< OneD, Array< OneD, NekDouble > > &outarray) override

GLOBAL_MAPPING_EXPORT void	v_CovarToCartesian (const Array< OneD, Array< OneD, NekDouble > > &inarray, Array< OneD, Array< OneD, NekDouble > > &outarray) override

GLOBAL_MAPPING_EXPORT void	v_ContravarFromCartesian (const Array< OneD, Array< OneD, NekDouble > > &inarray, Array< OneD, Array< OneD, NekDouble > > &outarray) override

GLOBAL_MAPPING_EXPORT void	v_CovarFromCartesian (const Array< OneD, Array< OneD, NekDouble > > &inarray, Array< OneD, Array< OneD, NekDouble > > &outarray) override

GLOBAL_MAPPING_EXPORT void	v_GetJacobian (Array< OneD, NekDouble > &outarray) override

GLOBAL_MAPPING_EXPORT void	v_GetMetricTensor (Array< OneD, Array< OneD, NekDouble > > &outarray) override

GLOBAL_MAPPING_EXPORT void	v_GetInvMetricTensor (Array< OneD, Array< OneD, NekDouble > > &outarray) override

GLOBAL_MAPPING_EXPORT void	v_ApplyChristoffelContravar (const Array< OneD, Array< OneD, NekDouble > > &inarray, Array< OneD, Array< OneD, NekDouble > > &outarray) override

GLOBAL_MAPPING_EXPORT void	v_ApplyChristoffelCovar (const Array< OneD, Array< OneD, NekDouble > > &inarray, Array< OneD, Array< OneD, NekDouble > > &outarray) override

GLOBAL_MAPPING_EXPORT void	v_UpdateGeomInfo () override

Protected Member Functions inherited from Nektar::GlobalMapping::Mapping
GLOBAL_MAPPING_EXPORT	Mapping (const LibUtilities::SessionReaderSharedPtr &pSession, const Array< OneD, MultiRegions::ExpListSharedPtr > &pFields)
	Constructor. More...

GLOBAL_MAPPING_EXPORT void	EvaluateFunction (Array< OneD, MultiRegions::ExpListSharedPtr > pFields, LibUtilities::SessionReaderSharedPtr pSession, std::string pFieldName, Array< OneD, NekDouble > &pArray, const std::string &pFunctionName, NekDouble pTime=NekDouble(0))

GLOBAL_MAPPING_EXPORT void	EvaluateTimeFunction (LibUtilities::SessionReaderSharedPtr pSession, std::string pFieldName, Array< OneD, NekDouble > &pArray, const std::string &pFunctionName, NekDouble pTime=NekDouble(0))

virtual GLOBAL_MAPPING_EXPORT void	v_InitObject (const Array< OneD, MultiRegions::ExpListSharedPtr > &pFields, const TiXmlElement *pMapping)

virtual GLOBAL_MAPPING_EXPORT void	v_ContravarToCartesian (const Array< OneD, Array< OneD, NekDouble > > &inarray, Array< OneD, Array< OneD, NekDouble > > &outarray)=0

virtual GLOBAL_MAPPING_EXPORT void	v_CovarToCartesian (const Array< OneD, Array< OneD, NekDouble > > &inarray, Array< OneD, Array< OneD, NekDouble > > &outarray)=0

virtual GLOBAL_MAPPING_EXPORT void	v_ContravarFromCartesian (const Array< OneD, Array< OneD, NekDouble > > &inarray, Array< OneD, Array< OneD, NekDouble > > &outarray)=0

virtual GLOBAL_MAPPING_EXPORT void	v_CovarFromCartesian (const Array< OneD, Array< OneD, NekDouble > > &inarray, Array< OneD, Array< OneD, NekDouble > > &outarray)=0

virtual GLOBAL_MAPPING_EXPORT void	v_GetCartesianCoordinates (Array< OneD, NekDouble > &out0, Array< OneD, NekDouble > &out1, Array< OneD, NekDouble > &out2)

virtual GLOBAL_MAPPING_EXPORT void	v_GetCoordVelocity (Array< OneD, Array< OneD, NekDouble > > &outarray)

virtual GLOBAL_MAPPING_EXPORT void	v_GetJacobian (Array< OneD, NekDouble > &outarray)=0

virtual GLOBAL_MAPPING_EXPORT void	v_DotGradJacobian (const Array< OneD, Array< OneD, NekDouble > > &inarray, Array< OneD, NekDouble > &outarray)

virtual GLOBAL_MAPPING_EXPORT void	v_GetMetricTensor (Array< OneD, Array< OneD, NekDouble > > &outarray)=0

virtual GLOBAL_MAPPING_EXPORT void	v_GetInvMetricTensor (Array< OneD, Array< OneD, NekDouble > > &outarray)=0

virtual GLOBAL_MAPPING_EXPORT void	v_LowerIndex (const Array< OneD, Array< OneD, NekDouble > > &inarray, Array< OneD, Array< OneD, NekDouble > > &outarray)

virtual GLOBAL_MAPPING_EXPORT void	v_RaiseIndex (const Array< OneD, Array< OneD, NekDouble > > &inarray, Array< OneD, Array< OneD, NekDouble > > &outarray)

virtual GLOBAL_MAPPING_EXPORT void	v_ApplyChristoffelContravar (const Array< OneD, Array< OneD, NekDouble > > &inarray, Array< OneD, Array< OneD, NekDouble > > &outarray)=0

virtual GLOBAL_MAPPING_EXPORT void	v_ApplyChristoffelCovar (const Array< OneD, Array< OneD, NekDouble > > &inarray, Array< OneD, Array< OneD, NekDouble > > &outarray)=0

virtual GLOBAL_MAPPING_EXPORT void	v_Divergence (const Array< OneD, Array< OneD, NekDouble > > &inarray, Array< OneD, NekDouble > &outarray)

virtual GLOBAL_MAPPING_EXPORT void	v_VelocityLaplacian (const Array< OneD, Array< OneD, NekDouble > > &inarray, Array< OneD, Array< OneD, NekDouble > > &outarray, const NekDouble alpha)

virtual GLOBAL_MAPPING_EXPORT void	v_gradgradU (const Array< OneD, Array< OneD, NekDouble > > &inarray, Array< OneD, Array< OneD, NekDouble > > &outarray)

virtual GLOBAL_MAPPING_EXPORT void	v_CurlCurlField (Array< OneD, Array< OneD, NekDouble > > &inarray, Array< OneD, Array< OneD, NekDouble > > &outarray, const bool generalized)

virtual GLOBAL_MAPPING_EXPORT void	v_UpdateMapping (const NekDouble time, const Array< OneD, Array< OneD, NekDouble > > &coords=NullNekDoubleArrayOfArray, const Array< OneD, Array< OneD, NekDouble > > &coordsVel=NullNekDoubleArrayOfArray)

virtual GLOBAL_MAPPING_EXPORT void	v_UpdateGeomInfo ()=0

virtual GLOBAL_MAPPING_EXPORT void	v_UpdateBCs (const NekDouble time)

Protected Attributes
Array< OneD, Array< OneD, NekDouble > >	m_metricTensor

Array< OneD, Array< OneD, NekDouble > >	m_invMetricTensor

Array< OneD, Array< OneD, NekDouble > >	m_deriv

Array< OneD, Array< OneD, NekDouble > >	m_invDeriv

Array< OneD, Array< OneD, NekDouble > >	m_Christoffel

Array< OneD, NekDouble >	m_jac

Protected Attributes inherited from Nektar::GlobalMapping::Mapping
LibUtilities::SessionReaderSharedPtr	m_session
	Session reader. More...

LibUtilities::FieldIOSharedPtr	m_fld

Array< OneD, MultiRegions::ExpListSharedPtr >	m_fields

Array< OneD, Array< OneD, NekDouble > >	m_coords
	Array with the Cartesian coordinates. More...

Array< OneD, Array< OneD, NekDouble > >	m_coordsVel
	Array with the velocity of the coordinates. More...

Array< OneD, Array< OneD, NekDouble > >	m_GeometricInfo
	Array with metric terms of the mapping. More...

int	m_nConvectiveFields
	Number of velocity components. More...

std::string	m_funcName
	Name of the function containing the coordinates. More...

std::string	m_velFuncName
	Name of the function containing the velocity of the coordinates. More...

bool	m_constantJacobian
	Flag defining if the Jacobian is constant. More...

bool	m_timeDependent
	Flag defining if the Mapping is time-dependent. More...

bool	m_fromFunction
	Flag defining if the Mapping is defined by a function. More...

Array< OneD, Array< OneD, NekDouble > >	m_wk1

Array< OneD, Array< OneD, NekDouble > >	m_wk2

Array< OneD, Array< OneD, NekDouble > >	m_tmp

Friends
class	MemoryManager< MappingGeneral >

Additional Inherited Members
Public Member Functions inherited from Nektar::GlobalMapping::Mapping
virtual GLOBAL_MAPPING_EXPORT	~Mapping ()
	Destructor. More...

GLOBAL_MAPPING_EXPORT void	InitObject (const Array< OneD, MultiRegions::ExpListSharedPtr > &pFields, const TiXmlElement *pMapping)
	Initialise the mapping object. More...

GLOBAL_MAPPING_EXPORT void	ReplaceField (const Array< OneD, MultiRegions::ExpListSharedPtr > &pFields)
	Replace the Expansion List used by the mapping. More...

GLOBAL_MAPPING_EXPORT void	Output (LibUtilities::FieldMetaDataMap &fieldMetaDataMap, const std::string &outname)
	Output function called when a chk or fld file is written. More...

GLOBAL_MAPPING_EXPORT void	ContravarToCartesian (const Array< OneD, Array< OneD, NekDouble > > &inarray, Array< OneD, Array< OneD, NekDouble > > &outarray)
	Convert a contravariant vector to the Cartesian system. More...

GLOBAL_MAPPING_EXPORT void	CovarToCartesian (const Array< OneD, Array< OneD, NekDouble > > &inarray, Array< OneD, Array< OneD, NekDouble > > &outarray)
	Convert a covariant vector to the Cartesian system. More...

GLOBAL_MAPPING_EXPORT void	ContravarFromCartesian (const Array< OneD, Array< OneD, NekDouble > > &inarray, Array< OneD, Array< OneD, NekDouble > > &outarray)
	Convert a contravariant vector to the transformed system. More...

GLOBAL_MAPPING_EXPORT void	CovarFromCartesian (const Array< OneD, Array< OneD, NekDouble > > &inarray, Array< OneD, Array< OneD, NekDouble > > &outarray)
	Convert a covariant vector to the transformed system. More...

GLOBAL_MAPPING_EXPORT void	GetCartesianCoordinates (Array< OneD, NekDouble > &out0, Array< OneD, NekDouble > &out1, Array< OneD, NekDouble > &out2)
	Get the Cartesian coordinates in the field. More...

GLOBAL_MAPPING_EXPORT void	GetJacobian (Array< OneD, NekDouble > &outarray)
	Get the Jacobian of the transformation. More...

GLOBAL_MAPPING_EXPORT void	DotGradJacobian (const Array< OneD, Array< OneD, NekDouble > > &inarray, Array< OneD, NekDouble > &outarray)
	Calculate the dot product with the gradient of the Jacobian. More...

GLOBAL_MAPPING_EXPORT void	GetMetricTensor (Array< OneD, Array< OneD, NekDouble > > &outarray)
	Get the metric tensor \(g_{ij}\). More...

GLOBAL_MAPPING_EXPORT void	GetInvMetricTensor (Array< OneD, Array< OneD, NekDouble > > &outarray)
	Get the inverse of metric tensor \(g^{ij}\). More...

GLOBAL_MAPPING_EXPORT void	LowerIndex (const Array< OneD, Array< OneD, NekDouble > > &inarray, Array< OneD, Array< OneD, NekDouble > > &outarray)
	Lower index of vector: \(v_{i} = g_{ij}*v^{j}\). More...

GLOBAL_MAPPING_EXPORT void	RaiseIndex (const Array< OneD, Array< OneD, NekDouble > > &inarray, Array< OneD, Array< OneD, NekDouble > > &outarray)
	Raise index of vector: \(v^{i} = g^{ij}*v_{j}\). More...

GLOBAL_MAPPING_EXPORT void	ApplyChristoffelContravar (const Array< OneD, Array< OneD, NekDouble > > &inarray, Array< OneD, Array< OneD, NekDouble > > &outarray)
	Apply the Christoffel symbols to a contravariant vector. More...

GLOBAL_MAPPING_EXPORT void	ApplyChristoffelCovar (const Array< OneD, Array< OneD, NekDouble > > &inarray, Array< OneD, Array< OneD, NekDouble > > &outarray)
	Apply the Christoffel symbols to a covariant vector. More...

GLOBAL_MAPPING_EXPORT void	GetCoordVelocity (Array< OneD, Array< OneD, NekDouble > > &outarray)
	Obtain the velocity of the coordinates. More...

GLOBAL_MAPPING_EXPORT void	Divergence (const Array< OneD, Array< OneD, NekDouble > > &inarray, Array< OneD, NekDouble > &outarray)
	Calculate the generalised divergence operator. More...

GLOBAL_MAPPING_EXPORT void	VelocityLaplacian (const Array< OneD, Array< OneD, NekDouble > > &inarray, Array< OneD, Array< OneD, NekDouble > > &outarray, const NekDouble alpha=0.0)
	Generalised (correction to the) velocity Laplacian operator. More...

GLOBAL_MAPPING_EXPORT void	gradgradU (const Array< OneD, Array< OneD, NekDouble > > &inarray, Array< OneD, Array< OneD, NekDouble > > &outarray)
	Second order covariant derivatives of a contravariant vector. More...

GLOBAL_MAPPING_EXPORT void	CurlCurlField (Array< OneD, Array< OneD, NekDouble > > &inarray, Array< OneD, Array< OneD, NekDouble > > &outarray, const bool generalized)
	CurlCurl calculated on the whole field. More...

GLOBAL_MAPPING_EXPORT bool	IsTimeDependent ()
	Get flag defining if mapping is time-dependent. More...

GLOBAL_MAPPING_EXPORT void	SetTimeDependent (const bool value)
	Set flag defining if mapping is time-dependent. More...

GLOBAL_MAPPING_EXPORT bool	IsFromFunction ()
	Get flag defining if mapping is defined by a function. More...

GLOBAL_MAPPING_EXPORT void	SetFromFunction (const bool value)
	Set flag defining if mapping is defined by a function. More...

GLOBAL_MAPPING_EXPORT bool	HasConstantJacobian ()
	Get flag defining if mapping has constant Jacobian. More...

GLOBAL_MAPPING_EXPORT bool	IsDefined ()
	Get flag determining if the mapping was defined or is trivial. More...

GLOBAL_MAPPING_EXPORT void	UpdateBCs (const NekDouble time)
	Update the Dirichlet Boundary Conditions when using Mappings. More...

GLOBAL_MAPPING_EXPORT void	UpdateMapping (const NekDouble time, const Array< OneD, Array< OneD, NekDouble > > &coords=NullNekDoubleArrayOfArray, const Array< OneD, Array< OneD, NekDouble > > &coordsVel=NullNekDoubleArrayOfArray)
	Update the Mapping with new coordinates. More...

GLOBAL_MAPPING_EXPORT void	UpdateGeomInfo ()
	Recompute the metric terms of the Mapping. More...

Static Protected Attributes inherited from Nektar::GlobalMapping::Mapping
static MappingSharedPtr	m_mappingPtr = MappingSharedPtr()

static bool	m_init = false

static bool	m_isDefined = false

Detailed Description

This class implements the most general mapping, defined by the transformation

\[ \bar{x} = \bar{x}(x,y,z) \]

\[ \bar{y} = \bar{y}(x,y,z) \]

\[ \bar{z} = \bar{z}(x,y,z) \]

where \((\bar{x},\bar{y},\bar{z})\) are the Cartesian (physical) coordinates and \((x,y,z)\) are the transformed (computational) coordinates.

Definition at line 49 of file MappingGeneral.h.

Constructor & Destructor Documentation

◆ MappingGeneral()

Nektar::GlobalMapping::MappingGeneral::MappingGeneral	(	const LibUtilities::SessionReaderSharedPtr &	pSession,
		const Array< OneD, MultiRegions::ExpListSharedPtr > &	pFields
	)

protected

Definition at line 57 of file MappingGeneral.cpp.

    : Mapping(pSession, pFields)
{
}

Member Function Documentation

◆ CalculateChristoffel()

void Nektar::GlobalMapping::MappingGeneral::CalculateChristoffel ( )

protected

Definition at line 379 of file MappingGeneral.cpp.

{
    int physTot = m_fields[0]->GetTotPoints();
    int nvel    = m_nConvectiveFields;
 
    Array<OneD, Array<OneD, NekDouble>> gradG(nvel * nvel * nvel);
    Array<OneD, Array<OneD, NekDouble>> tmp(nvel * nvel * nvel);
    m_Christoffel = Array<OneD, Array<OneD, NekDouble>>(nvel * nvel * nvel);
    // Allocate memory
    for (int i = 0; i < gradG.size(); i++)
    {
        gradG[i]         = Array<OneD, NekDouble>(physTot, 0.0);
        tmp[i]           = Array<OneD, NekDouble>(physTot, 0.0);
        m_Christoffel[i] = Array<OneD, NekDouble>(physTot, 0.0);
    }
 
    // Set wavespace to false and store current value
    bool waveSpace = m_fields[0]->GetWaveSpace();
    m_fields[0]->SetWaveSpace(false);
 
    // Calculate gradients of g_ij
    for (int i = 0; i < nvel; i++)
    {
        for (int j = 0; j < nvel; j++)
        {
            for (int k = 0; k < nvel; k++)
            {
                m_fields[0]->PhysDeriv(MultiRegions::DirCartesianMap[k],
                                       m_metricTensor[i * nvel + j],
                                       gradG[i * nvel * nvel + j * nvel + k]);
            }
        }
    }
 
    // Calculate tmp[p,j,k] = 1/2( gradG[pj,k]+ gradG[pk,j]-gradG[jk,p])
    for (int p = 0; p < nvel; p++)
    {
        for (int j = 0; j < nvel; j++)
        {
            for (int k = 0; k < nvel; k++)
            {
                Vmath::Vadd(physTot, gradG[p * nvel * nvel + j * nvel + k], 1,
                            gradG[p * nvel * nvel + k * nvel + j], 1,
                            tmp[p * nvel * nvel + j * nvel + k], 1);
                Vmath::Vsub(physTot, tmp[p * nvel * nvel + j * nvel + k], 1,
                            gradG[j * nvel * nvel + k * nvel + p], 1,
                            tmp[p * nvel * nvel + j * nvel + k], 1);
                Vmath::Smul(physTot, 0.5, tmp[p * nvel * nvel + j * nvel + k],
                            1, tmp[p * nvel * nvel + j * nvel + k], 1);
            }
        }
    }
 
    // Calculate Christoffel symbols = g^ip tmp[p,j,k]
    for (int i = 0; i < nvel; i++)
    {
        for (int j = 0; j < nvel; j++)
        {
            for (int k = 0; k < nvel; k++)
            {
                for (int p = 0; p < nvel; p++)
                {
                    Vmath::Vvtvp(
                        physTot, m_invMetricTensor[i * nvel + p], 1,
                        tmp[p * nvel * nvel + j * nvel + k], 1,
                        m_Christoffel[i * nvel * nvel + j * nvel + k], 1,
                        m_Christoffel[i * nvel * nvel + j * nvel + k], 1);
                }
            }
        }
    }
    // Restore wavespace
    m_fields[0]->SetWaveSpace(waveSpace);
}

References Nektar::MultiRegions::DirCartesianMap, m_Christoffel, Nektar::GlobalMapping::Mapping::m_fields, m_invMetricTensor, m_metricTensor, Nektar::GlobalMapping::Mapping::m_nConvectiveFields, CellMLToNektar.cellml_metadata::p, Vmath::Smul(), Vmath::Vadd(), Vmath::Vsub(), and Vmath::Vvtvp().

Referenced by v_UpdateGeomInfo().

◆ CalculateMetricTerms()

void Nektar::GlobalMapping::MappingGeneral::CalculateMetricTerms ( )

protected

Definition at line 245 of file MappingGeneral.cpp.

{
    int physTot = m_fields[0]->GetTotPoints();
    int nvel    = m_nConvectiveFields;
 
    // Set wavespace to false and store current value
    bool wavespace = m_fields[0]->GetWaveSpace();
    m_fields[0]->SetWaveSpace(false);
 
    // Allocate memory
    m_metricTensor    = Array<OneD, Array<OneD, NekDouble>>(nvel * nvel);
    m_invMetricTensor = Array<OneD, Array<OneD, NekDouble>>(nvel * nvel);
    m_deriv           = Array<OneD, Array<OneD, NekDouble>>(nvel * nvel);
    m_invDeriv        = Array<OneD, Array<OneD, NekDouble>>(nvel * nvel);
    for (int i = 0; i < m_metricTensor.size(); i++)
    {
        m_metricTensor[i]    = Array<OneD, NekDouble>(physTot, 0.0);
        m_invMetricTensor[i] = Array<OneD, NekDouble>(physTot, 0.0);
        m_deriv[i]           = Array<OneD, NekDouble>(physTot, 0.0);
        m_invDeriv[i]        = Array<OneD, NekDouble>(physTot, 0.0);
    }
    m_jac = Array<OneD, NekDouble>(physTot, 0.0);
 
    // First, calculate derivatives of the mapping ->  dX^i/dx^j = c^i_j
    for (int i = 0; i < nvel; i++)
    {
        for (int j = 0; j < nvel; j++)
        {
            m_fields[0]->PhysDeriv(MultiRegions::DirCartesianMap[j],
                                   m_coords[i], m_deriv[i * nvel + j]);
        }
    }
    // In Homogeneous case, m_deriv(2,2) needs to be set to 1
    //  because differentiation in wavespace is not valid for non-periodic field
    if (m_fields[0]->GetExpType() == MultiRegions::e3DH1D)
    {
        Vmath::Fill(physTot, 1.0, m_deriv[2 * nvel + 2], 1);
    }
 
    // Now calculate the metric tensor -->   g_ij = sum_k  { c^k_i c^k_j }
    for (int i = 0; i < nvel; i++)
    {
        for (int j = 0; j < nvel; j++)
        {
            for (int k = 0; k < nvel; k++)
            {
                Vmath::Vvtvp(physTot, m_deriv[k * nvel + i], 1,
                             m_deriv[k * nvel + j], 1,
                             m_metricTensor[i * nvel + j], 1,
                             m_metricTensor[i * nvel + j], 1);
            }
        }
    }
 
    // Put the adjoint of g in m_invMetricTensor
    switch (nvel)
    {
        case 1:
            Vmath::Fill(physTot, 1.0, m_invMetricTensor[0], 1);
            break;
        case 2:
            Vmath::Vcopy(physTot, m_metricTensor[1 * nvel + 1], 1,
                         m_invMetricTensor[0 * nvel + 0], 1);
            Vmath::Smul(physTot, -1.0, m_metricTensor[0 * nvel + 1], 1,
                        m_invMetricTensor[1 * nvel + 0], 1);
            Vmath::Smul(physTot, -1.0, m_metricTensor[1 * nvel + 0], 1,
                        m_invMetricTensor[0 * nvel + 1], 1);
            Vmath::Vcopy(physTot, m_metricTensor[0 * nvel + 0], 1,
                         m_invMetricTensor[1 * nvel + 1], 1);
            break;
        case 3:
        {
            int a, b, c, d, e, i, j;
 
            // Compute g^{ij} by computing Cofactors(g_ij)^T
            for (i = 0; i < nvel; ++i)
            {
                for (j = 0; j < nvel; ++j)
                {
                    a = ((i + 1) % nvel) * nvel + ((j + 1) % nvel);
                    b = ((i + 1) % nvel) * nvel + ((j + 2) % nvel);
                    c = ((i + 2) % nvel) * nvel + ((j + 1) % nvel);
                    d = ((i + 2) % nvel) * nvel + ((j + 2) % nvel);
                    e = i * nvel + j;
                    // a*d - b*c
                    Vmath::Vmul(physTot, m_metricTensor[b], 1,
                                m_metricTensor[c], 1, m_invMetricTensor[e], 1);
                    Vmath::Vvtvm(physTot, m_metricTensor[a], 1,
                                 m_metricTensor[d], 1, m_invMetricTensor[e], 1,
                                 m_invMetricTensor[e], 1);
                }
            }
            break;
        }
    }
 
    // Compute g = det(g_{ij}) (= Jacobian squared) and store
    // temporarily in m_jac.
    for (int i = 0; i < nvel; ++i)
    {
        Vmath::Vvtvp(physTot, m_metricTensor[i], 1, m_invMetricTensor[i * nvel],
                     1, m_jac, 1, m_jac, 1);
    }
 
    // Calculate g^ij (the inverse of g_ij) by dividing by jac
    for (int i = 0; i < nvel * nvel; ++i)
    {
        Vmath::Vdiv(physTot, m_invMetricTensor[i], 1, m_jac, 1,
                    m_invMetricTensor[i], 1);
    }
 
    // Compute the Jacobian = sqrt(g)
    Vmath::Vsqrt(physTot, m_jac, 1, m_jac, 1);
 
    // Calculate the derivatives of the inverse transformation
    //          c'^j_i = dx^j/dX^i = sum_k {g^jk c^i_k}
    for (int i = 0; i < nvel; ++i)
    {
        for (int j = 0; j < nvel; ++j)
        {
            for (int k = 0; k < nvel; ++k)
            {
                Vmath::Vvtvp(physTot, m_deriv[i * nvel + k], 1,
                             m_invMetricTensor[j * nvel + k], 1,
                             m_invDeriv[i * nvel + j], 1,
                             m_invDeriv[i * nvel + j], 1);
            }
        }
    }
 
    // Restore value of wavespace
    m_fields[0]->SetWaveSpace(wavespace);
}

References Nektar::UnitTests::d(), Nektar::MultiRegions::DirCartesianMap, Nektar::MultiRegions::e3DH1D, Vmath::Fill(), Nektar::GlobalMapping::Mapping::m_coords, m_deriv, Nektar::GlobalMapping::Mapping::m_fields, m_invDeriv, m_invMetricTensor, m_jac, m_metricTensor, Nektar::GlobalMapping::Mapping::m_nConvectiveFields, Vmath::Smul(), Vmath::Vcopy(), Vmath::Vdiv(), Vmath::Vmul(), Vmath::Vsqrt(), Vmath::Vvtvm(), and Vmath::Vvtvp().

Referenced by v_UpdateGeomInfo().

◆ create()

static GLOBAL_MAPPING_EXPORT MappingSharedPtr Nektar::GlobalMapping::MappingGeneral::create	(	const LibUtilities::SessionReaderSharedPtr &	pSession,
		const Array< OneD, MultiRegions::ExpListSharedPtr > &	pFields,
		const TiXmlElement *	pMapping
	)

inlinestatic

Creates an instance of this class.

Definition at line 56 of file MappingGeneral.h.

    {
        MappingSharedPtr p =
            MemoryManager<MappingGeneral>::AllocateSharedPtr(pSession, pFields);
        p->InitObject(pFields, pMapping);
        return p;
    }

References Nektar::MemoryManager< DataType >::AllocateSharedPtr(), Nektar::GlobalMapping::MappingSharedPtr, and CellMLToNektar.cellml_metadata::p.

◆ v_ApplyChristoffelContravar()

void Nektar::GlobalMapping::MappingGeneral::v_ApplyChristoffelContravar	(	const Array< OneD, Array< OneD, NekDouble > > &	inarray,
		Array< OneD, Array< OneD, NekDouble > > &	outarray
	)

overrideprotectedvirtual

Implements Nektar::GlobalMapping::Mapping.

Definition at line 191 of file MappingGeneral.cpp.

{
    int physTot = m_fields[0]->GetTotPoints();
    int nvel    = m_nConvectiveFields;
 
    // Calculate {i,jk} u^j
    for (int i = 0; i < nvel; i++)
    {
        for (int k = 0; k < nvel; k++)
        {
            outarray[i * nvel + k] = Array<OneD, NekDouble>(physTot, 0.0);
            for (int j = 0; j < nvel; j++)
            {
                Vmath::Vvtvp(physTot, inarray[j], 1,
                             m_Christoffel[i * nvel * nvel + j * nvel + k], 1,
                             outarray[i * nvel + k], 1, outarray[i * nvel + k],
                             1);
            }
        }
    }
}

References m_Christoffel, Nektar::GlobalMapping::Mapping::m_fields, Nektar::GlobalMapping::Mapping::m_nConvectiveFields, and Vmath::Vvtvp().

◆ v_ApplyChristoffelCovar()

void Nektar::GlobalMapping::MappingGeneral::v_ApplyChristoffelCovar	(	const Array< OneD, Array< OneD, NekDouble > > &	inarray,
		Array< OneD, Array< OneD, NekDouble > > &	outarray
	)

overrideprotectedvirtual

Implements Nektar::GlobalMapping::Mapping.

Definition at line 215 of file MappingGeneral.cpp.

{
    int physTot = m_fields[0]->GetTotPoints();
    int nvel    = m_nConvectiveFields;
 
    // Calculate {i,jk} u_i
    for (int j = 0; j < nvel; j++)
    {
        for (int k = 0; k < nvel; k++)
        {
            outarray[j * nvel + k] = Array<OneD, NekDouble>(physTot, 0.0);
            for (int i = 0; i < nvel; i++)
            {
                Vmath::Vvtvp(physTot, inarray[i], 1,
                             m_Christoffel[i * nvel * nvel + j * nvel + k], 1,
                             outarray[j * nvel + k], 1, outarray[j * nvel + k],
                             1);
            }
        }
    }
}

References m_Christoffel, Nektar::GlobalMapping::Mapping::m_fields, Nektar::GlobalMapping::Mapping::m_nConvectiveFields, and Vmath::Vvtvp().

◆ v_ContravarFromCartesian()

void Nektar::GlobalMapping::MappingGeneral::v_ContravarFromCartesian	(	const Array< OneD, Array< OneD, NekDouble > > &	inarray,
		Array< OneD, Array< OneD, NekDouble > > &	outarray
	)

overrideprotectedvirtual

Implements Nektar::GlobalMapping::Mapping.

Definition at line 115 of file MappingGeneral.cpp.

{
    int physTot = m_fields[0]->GetTotPoints();
    int nvel    = m_nConvectiveFields;
 
    for (int i = 0; i < nvel; i++)
    {
        outarray[i] = Array<OneD, NekDouble>(physTot, 0.0);
        for (int j = 0; j < nvel; j++)
        {
            Vmath::Vvtvp(physTot, inarray[j], 1, m_invDeriv[j * nvel + i], 1,
                         outarray[i], 1, outarray[i], 1);
        }
    }
}

References Nektar::GlobalMapping::Mapping::m_fields, m_invDeriv, Nektar::GlobalMapping::Mapping::m_nConvectiveFields, and Vmath::Vvtvp().

◆ v_ContravarToCartesian()

void Nektar::GlobalMapping::MappingGeneral::v_ContravarToCartesian	(	const Array< OneD, Array< OneD, NekDouble > > &	inarray,
		Array< OneD, Array< OneD, NekDouble > > &	outarray
	)

overrideprotectedvirtual

Implements Nektar::GlobalMapping::Mapping.

Definition at line 79 of file MappingGeneral.cpp.

{
    int physTot = m_fields[0]->GetTotPoints();
    int nvel    = m_nConvectiveFields;
 
    for (int i = 0; i < nvel; i++)
    {
        outarray[i] = Array<OneD, NekDouble>(physTot, 0.0);
        for (int j = 0; j < nvel; j++)
        {
            Vmath::Vvtvp(physTot, inarray[j], 1, m_deriv[i * nvel + j], 1,
                         outarray[i], 1, outarray[i], 1);
        }
    }
}

References m_deriv, Nektar::GlobalMapping::Mapping::m_fields, Nektar::GlobalMapping::Mapping::m_nConvectiveFields, and Vmath::Vvtvp().

◆ v_CovarFromCartesian()

void Nektar::GlobalMapping::MappingGeneral::v_CovarFromCartesian	(	const Array< OneD, Array< OneD, NekDouble > > &	inarray,
		Array< OneD, Array< OneD, NekDouble > > &	outarray
	)

overrideprotectedvirtual

Implements Nektar::GlobalMapping::Mapping.

Definition at line 133 of file MappingGeneral.cpp.

{
    int physTot = m_fields[0]->GetTotPoints();
    int nvel    = m_nConvectiveFields;
 
    for (int i = 0; i < nvel; i++)
    {
        outarray[i] = Array<OneD, NekDouble>(physTot, 0.0);
        for (int j = 0; j < nvel; j++)
        {
            Vmath::Vvtvp(physTot, inarray[j], 1, m_deriv[j * nvel + i], 1,
                         outarray[i], 1, outarray[i], 1);
        }
    }
}

References m_deriv, Nektar::GlobalMapping::Mapping::m_fields, Nektar::GlobalMapping::Mapping::m_nConvectiveFields, and Vmath::Vvtvp().

◆ v_CovarToCartesian()

void Nektar::GlobalMapping::MappingGeneral::v_CovarToCartesian	(	const Array< OneD, Array< OneD, NekDouble > > &	inarray,
		Array< OneD, Array< OneD, NekDouble > > &	outarray
	)

overrideprotectedvirtual

Implements Nektar::GlobalMapping::Mapping.

Definition at line 97 of file MappingGeneral.cpp.

{
    int physTot = m_fields[0]->GetTotPoints();
    int nvel    = m_nConvectiveFields;
 
    for (int i = 0; i < nvel; i++)
    {
        outarray[i] = Array<OneD, NekDouble>(physTot, 0.0);
        for (int j = 0; j < nvel; j++)
        {
            Vmath::Vvtvp(physTot, inarray[j], 1, m_invDeriv[i * nvel + j], 1,
                         outarray[i], 1, outarray[i], 1);
        }
    }
}

References Nektar::GlobalMapping::Mapping::m_fields, m_invDeriv, Nektar::GlobalMapping::Mapping::m_nConvectiveFields, and Vmath::Vvtvp().

◆ v_GetInvMetricTensor()

void Nektar::GlobalMapping::MappingGeneral::v_GetInvMetricTensor ( Array< OneD, Array< OneD, NekDouble > > & outarray )

overrideprotectedvirtual

Implements Nektar::GlobalMapping::Mapping.

Definition at line 174 of file MappingGeneral.cpp.

{
    int physTot = m_fields[0]->GetTotPoints();
    int nvel    = m_nConvectiveFields;
 
    for (int i = 0; i < nvel; i++)
    {
        for (int j = 0; j < nvel; j++)
        {
            outarray[i * nvel + j] = Array<OneD, NekDouble>(physTot, 0.0);
            Vmath::Vcopy(physTot, m_invMetricTensor[i * nvel + j], 1,
                         outarray[i * nvel + j], 1);
        }
    }
}

References Nektar::GlobalMapping::Mapping::m_fields, m_invMetricTensor, Nektar::GlobalMapping::Mapping::m_nConvectiveFields, and Vmath::Vcopy().

◆ v_GetJacobian()

void Nektar::GlobalMapping::MappingGeneral::v_GetJacobian ( Array< OneD, NekDouble > & outarray )

overrideprotectedvirtual

Implements Nektar::GlobalMapping::Mapping.

Definition at line 151 of file MappingGeneral.cpp.

{
    int physTot = m_fields[0]->GetTotPoints();
    Vmath::Vcopy(physTot, m_jac, 1, outarray, 1);
}

References Nektar::GlobalMapping::Mapping::m_fields, m_jac, and Vmath::Vcopy().

◆ v_GetMetricTensor()

void Nektar::GlobalMapping::MappingGeneral::v_GetMetricTensor ( Array< OneD, Array< OneD, NekDouble > > & outarray )

overrideprotectedvirtual

Implements Nektar::GlobalMapping::Mapping.

Definition at line 157 of file MappingGeneral.cpp.

{
    int physTot = m_fields[0]->GetTotPoints();
    int nvel    = m_nConvectiveFields;
 
    for (int i = 0; i < nvel; i++)
    {
        for (int j = 0; j < nvel; j++)
        {
            outarray[i * nvel + j] = Array<OneD, NekDouble>(physTot, 0.0);
            Vmath::Vcopy(physTot, m_metricTensor[i * nvel + j], 1,
                         outarray[i * nvel + j], 1);
        }
    }
}

References Nektar::GlobalMapping::Mapping::m_fields, m_metricTensor, Nektar::GlobalMapping::Mapping::m_nConvectiveFields, and Vmath::Vcopy().

◆ v_InitObject()

void Nektar::GlobalMapping::MappingGeneral::v_InitObject	(	const Array< OneD, MultiRegions::ExpListSharedPtr > &	pFields,
		const TiXmlElement *	pMapping
	)

overrideprotectedvirtual

This function initialises the Mapping object. It computes the coordinates and velocity coordinates, initialises the workspace variables, and calls UpdateGeomInfo, which will perform the calculations specific for each type of Mapping.

Parameters

pFields	ExpList array used in the mapping
pMapping	xml element describing the mapping

Reimplemented from Nektar::GlobalMapping::Mapping.

Definition at line 67 of file MappingGeneral.cpp.

{
    Mapping::v_InitObject(pFields, pMapping);
 
    m_constantJacobian = false;
 
    ASSERTL0(m_nConvectiveFields >= 2,
             "General Mapping needs at least 2 velocity components.");
}

References ASSERTL0, Nektar::GlobalMapping::Mapping::m_constantJacobian, Nektar::GlobalMapping::Mapping::m_nConvectiveFields, and Nektar::GlobalMapping::Mapping::v_InitObject().

◆ v_UpdateGeomInfo()

void Nektar::GlobalMapping::MappingGeneral::v_UpdateGeomInfo ( )

overrideprotectedvirtual

Implements Nektar::GlobalMapping::Mapping.

Definition at line 239 of file MappingGeneral.cpp.

{
    CalculateMetricTerms();
    CalculateChristoffel();
}

References CalculateChristoffel(), and CalculateMetricTerms().

Friends And Related Function Documentation

◆ MemoryManager< MappingGeneral >

friend class MemoryManager< MappingGeneral >

friend

Definition at line 1 of file MappingGeneral.h.

Member Data Documentation

◆ className

std::string Nektar::GlobalMapping::MappingGeneral::className

static

Initial value:

=
    GetMappingFactory().RegisterCreatorFunction(
        "General", MappingGeneral::create,
        "X = X(x,y,z), Y = Y(x,y,z), Z=Z(x,y,z)")

Name of the class.

Definition at line 68 of file MappingGeneral.h.

◆ m_Christoffel

Array<OneD, Array<OneD, NekDouble> > Nektar::GlobalMapping::MappingGeneral::m_Christoffel

protected

Definition at line 81 of file MappingGeneral.h.

Referenced by CalculateChristoffel(), v_ApplyChristoffelContravar(), and v_ApplyChristoffelCovar().

◆ m_deriv

Array<OneD, Array<OneD, NekDouble> > Nektar::GlobalMapping::MappingGeneral::m_deriv

protected

Definition at line 79 of file MappingGeneral.h.

Referenced by CalculateMetricTerms(), v_ContravarToCartesian(), and v_CovarFromCartesian().

◆ m_invDeriv

Array<OneD, Array<OneD, NekDouble> > Nektar::GlobalMapping::MappingGeneral::m_invDeriv

protected

Definition at line 80 of file MappingGeneral.h.

Referenced by CalculateMetricTerms(), v_ContravarFromCartesian(), and v_CovarToCartesian().

◆ m_invMetricTensor

Array<OneD, Array<OneD, NekDouble> > Nektar::GlobalMapping::MappingGeneral::m_invMetricTensor

protected

Definition at line 78 of file MappingGeneral.h.

Referenced by CalculateChristoffel(), CalculateMetricTerms(), and v_GetInvMetricTensor().

◆ m_jac

Array<OneD, NekDouble> Nektar::GlobalMapping::MappingGeneral::m_jac

protected

Definition at line 82 of file MappingGeneral.h.

Referenced by CalculateMetricTerms(), and v_GetJacobian().

◆ m_metricTensor

Array<OneD, Array<OneD, NekDouble> > Nektar::GlobalMapping::MappingGeneral::m_metricTensor

protected

Definition at line 77 of file MappingGeneral.h.

Referenced by CalculateChristoffel(), CalculateMetricTerms(), and v_GetMetricTensor().

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ MappingGeneral()

Member Function Documentation

◆ CalculateChristoffel()

◆ CalculateMetricTerms()

◆ create()

◆ v_ApplyChristoffelContravar()

◆ v_ApplyChristoffelCovar()

◆ v_ContravarFromCartesian()

◆ v_ContravarToCartesian()

◆ v_CovarFromCartesian()

◆ v_CovarToCartesian()

◆ v_GetInvMetricTensor()

◆ v_GetJacobian()

◆ v_GetMetricTensor()

◆ v_InitObject()

◆ v_UpdateGeomInfo()

Friends And Related Function Documentation

◆ MemoryManager< MappingGeneral >

Member Data Documentation

◆ className

◆ m_Christoffel

◆ m_deriv

◆ m_invDeriv

◆ m_invMetricTensor

◆ m_jac

◆ m_metricTensor