Nektar++
MappingXofZ.h
Go to the documentation of this file.
1///////////////////////////////////////////////////////////////////////////////
2//
3// File: MappingXofZ.h
4//
5// For more information, please see: http://www.nektar.info
6//
7// The MIT License
8//
9// Copyright (c) 2006 Division of Applied Mathematics, Brown University (USA),
10// Department of Aeronautics, Imperial College London (UK), and Scientific
11// Computing and Imaging Institute, University of Utah (USA).
12//
13// Permission is hereby granted, free of charge, to any person obtaining a
14// copy of this software and associated documentation files (the "Software"),
15// to deal in the Software without restriction, including without limitation
16// the rights to use, copy, modify, merge, publish, distribute, sublicense,
17// and/or sell copies of the Software, and to permit persons to whom the
18// Software is furnished to do so, subject to the following conditions:
19//
20// The above copyright notice and this permission notice shall be included
21// in all copies or substantial portions of the Software.
22//
23// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
24// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
25// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
26// THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
27// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
28// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
29// DEALINGS IN THE SOFTWARE.
30//
31// Description: Mapping of the type X = x + f(z)
32//
33///////////////////////////////////////////////////////////////////////////////
34
35#ifndef NEKTAR_GLOBALMAPPING_MAPPINGXOFZ
36#define NEKTAR_GLOBALMAPPING_MAPPINGXOFZ
37
38#include <string>
39
45
47{
48
49class MappingXofZ : public Mapping
50{
51public:
52 friend class MemoryManager<MappingXofZ>;
53
54 /// Creates an instance of this class
59 const TiXmlElement *pMapping)
60 {
63 p->InitObject(pFields, pMapping);
64 return p;
65 }
66
67 /// Name of the class
68 static std::string className;
69
70protected:
71 // Constructor
74
75 // Virtual functions
77 void v_InitObject(
79 const TiXmlElement *pMapping) override;
80
82 const Array<OneD, Array<OneD, NekDouble>> &inarray,
83 Array<OneD, Array<OneD, NekDouble>> &outarray) override;
84
86 const Array<OneD, Array<OneD, NekDouble>> &inarray,
87 Array<OneD, Array<OneD, NekDouble>> &outarray) override;
88
90 const Array<OneD, Array<OneD, NekDouble>> &inarray,
91 Array<OneD, Array<OneD, NekDouble>> &outarray) override;
92
94 const Array<OneD, Array<OneD, NekDouble>> &inarray,
95 Array<OneD, Array<OneD, NekDouble>> &outarray) override;
96
98 Array<OneD, NekDouble> &outarray) override;
99
101 const Array<OneD, Array<OneD, NekDouble>> &inarray,
102 Array<OneD, NekDouble> &outarray) override;
103
105 Array<OneD, Array<OneD, NekDouble>> &outarray) override;
106
108 Array<OneD, Array<OneD, NekDouble>> &outarray) override;
109
111 const Array<OneD, Array<OneD, NekDouble>> &inarray,
112 Array<OneD, Array<OneD, NekDouble>> &outarray) override;
113
115 const Array<OneD, Array<OneD, NekDouble>> &inarray,
116 Array<OneD, Array<OneD, NekDouble>> &outarray) override;
117
119 const Array<OneD, Array<OneD, NekDouble>> &inarray,
120 Array<OneD, Array<OneD, NekDouble>> &outarray) override;
121
123 const Array<OneD, Array<OneD, NekDouble>> &inarray,
124 Array<OneD, Array<OneD, NekDouble>> &outarray) override;
125
127
128private:
129};
130
131} // namespace Nektar::GlobalMapping
132
133#endif
#define GLOBAL_MAPPING_EXPORT
Base class for mapping to be applied to the coordinate system.
Definition: Mapping.h:67
GLOBAL_MAPPING_EXPORT void v_GetMetricTensor(Array< OneD, Array< OneD, NekDouble > > &outarray) override
MappingXofZ(const LibUtilities::SessionReaderSharedPtr &pSession, const Array< OneD, MultiRegions::ExpListSharedPtr > &pFields)
Definition: MappingXofZ.cpp:56
GLOBAL_MAPPING_EXPORT void v_RaiseIndex(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
Definition: MappingXofZ.cpp:96
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.
Definition: MappingXofZ.h:56
static std::string className
Name of the class.
Definition: MappingXofZ.h:68
GLOBAL_MAPPING_EXPORT void v_UpdateGeomInfo() 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_LowerIndex(const Array< OneD, Array< OneD, NekDouble > > &inarray, 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_ContravarFromCartesian(const Array< OneD, Array< OneD, NekDouble > > &inarray, 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_InitObject(const Array< OneD, MultiRegions::ExpListSharedPtr > &pFields, const TiXmlElement *pMapping) override
Definition: MappingXofZ.cpp:66
GLOBAL_MAPPING_EXPORT void v_DotGradJacobian(const Array< OneD, Array< OneD, NekDouble > > &inarray, Array< OneD, NekDouble > &outarray) override
GLOBAL_MAPPING_EXPORT void v_GetJacobian(Array< OneD, NekDouble > &outarray) override
GLOBAL_MAPPING_EXPORT void v_ContravarToCartesian(const Array< OneD, Array< OneD, NekDouble > > &inarray, Array< OneD, Array< OneD, NekDouble > > &outarray) override
Definition: MappingXofZ.cpp:78
GLOBAL_MAPPING_EXPORT void v_CovarFromCartesian(const Array< OneD, Array< OneD, NekDouble > > &inarray, Array< OneD, Array< OneD, NekDouble > > &outarray) override
General purpose memory allocation routines with the ability to allocate from thread specific memory p...
static std::shared_ptr< DataType > AllocateSharedPtr(const Args &...args)
Allocate a shared pointer from the memory pool.
GLOBAL_MAPPING_EXPORT typedef std::shared_ptr< Mapping > MappingSharedPtr
A shared pointer to a Mapping object.
Definition: Mapping.h:51
std::shared_ptr< SessionReader > SessionReaderSharedPtr