Nektar++
Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Member Functions | Private Attributes | Friends | List of all members
Nektar::SolverUtils::ForcingBody Class Reference

#include <ForcingBody.h>

Inheritance diagram for Nektar::SolverUtils::ForcingBody:
[legend]

Static Public Member Functions

static SOLVER_UTILS_EXPORT ForcingSharedPtr create (const LibUtilities::SessionReaderSharedPtr &pSession, const std::weak_ptr< EquationSystem > &pEquation, const Array< OneD, MultiRegions::ExpListSharedPtr > &pFields, const unsigned int &pNumForcingFields, const TiXmlElement *pForce)
 Creates an instance of this class. More...
 
- Static Public Member Functions inherited from Nektar::SolverUtils::Forcing
static SOLVER_UTILS_EXPORT std::vector< ForcingSharedPtrLoad (const LibUtilities::SessionReaderSharedPtr &pSession, const std::weak_ptr< EquationSystem > &pEquation, const Array< OneD, MultiRegions::ExpListSharedPtr > &pFields, const unsigned int &pNumForcingFields=0)
 

Static Public Attributes

static std::string classNameBody
 Name of the class. More...
 
static std::string classNameField
 

Protected Member Functions

SOLVER_UTILS_EXPORT void v_InitObject (const Array< OneD, MultiRegions::ExpListSharedPtr > &pFields, const unsigned int &pNumForcingFields, const TiXmlElement *pForce) override
 
SOLVER_UTILS_EXPORT void v_Apply (const Array< OneD, MultiRegions::ExpListSharedPtr > &fields, const Array< OneD, Array< OneD, NekDouble > > &inarray, Array< OneD, Array< OneD, NekDouble > > &outarray, const NekDouble &time) override
 
SOLVER_UTILS_EXPORT void v_ApplyCoeff (const Array< OneD, MultiRegions::ExpListSharedPtr > &fields, const Array< OneD, Array< OneD, NekDouble > > &inarray, Array< OneD, Array< OneD, NekDouble > > &outarray, const NekDouble &time) override
 
- Protected Member Functions inherited from Nektar::SolverUtils::Forcing
SOLVER_UTILS_EXPORT Forcing (const LibUtilities::SessionReaderSharedPtr &pSession, const std::weak_ptr< EquationSystem > &pEquation)
 Constructor. More...
 
virtual SOLVER_UTILS_EXPORT ~Forcing ()=default
 
virtual SOLVER_UTILS_EXPORT void v_InitObject (const Array< OneD, MultiRegions::ExpListSharedPtr > &pFields, const unsigned int &pNumForcingFields, const TiXmlElement *pForce)=0
 
virtual SOLVER_UTILS_EXPORT void v_Apply (const Array< OneD, MultiRegions::ExpListSharedPtr > &fields, const Array< OneD, Array< OneD, NekDouble > > &inarray, Array< OneD, Array< OneD, NekDouble > > &outarray, const NekDouble &time)=0
 
virtual SOLVER_UTILS_EXPORT void v_PreApply (const Array< OneD, MultiRegions::ExpListSharedPtr > &fields, const Array< OneD, Array< OneD, NekDouble > > &inarray, Array< OneD, Array< OneD, NekDouble > > &outarray, const NekDouble &time)
 
virtual SOLVER_UTILS_EXPORT void v_ApplyCoeff (const Array< OneD, MultiRegions::ExpListSharedPtr > &fields, const Array< OneD, Array< OneD, NekDouble > > &inarray, Array< OneD, Array< OneD, NekDouble > > &outarray, const NekDouble &time)
 
SOLVER_UTILS_EXPORT SessionFunctionSharedPtr GetFunction (const Array< OneD, MultiRegions::ExpListSharedPtr > &pFields, const LibUtilities::SessionReaderSharedPtr &pSession, std::string pName, bool pCache=false)
 Get a SessionFunction by name. More...
 
SOLVER_UTILS_EXPORT void EvaluateTimeFunction (LibUtilities::SessionReaderSharedPtr pSession, std::string pFieldName, Array< OneD, NekDouble > &pArray, const std::string &pFunctionName, NekDouble pTime=NekDouble(0))
 
SOLVER_UTILS_EXPORT void EvaluateTimeFunction (const NekDouble pTime, const LibUtilities::EquationSharedPtr &pEqn, Array< OneD, NekDouble > &pArray)
 

Private Member Functions

 ForcingBody (const LibUtilities::SessionReaderSharedPtr &pSession, const std::weak_ptr< EquationSystem > &pEquation)
 
 ~ForcingBody (void) override=default
 
void Update (const Array< OneD, MultiRegions::ExpListSharedPtr > &pFields, const Array< OneD, Array< OneD, NekDouble > > &inarray, const NekDouble &time)
 

Private Attributes

std::string m_funcName
 
bool m_hasTimeFcnScaling
 
LibUtilities::EquationSharedPtr m_timeFcnEqn
 
bool m_homogeneous
 
bool m_hasEvars
 
std::map< int, std::vector< int > > m_eqnEvars
 

Friends

class MemoryManager< ForcingBody >
 

Additional Inherited Members

- Public Member Functions inherited from Nektar::SolverUtils::Forcing
SOLVER_UTILS_EXPORT void InitObject (const Array< OneD, MultiRegions::ExpListSharedPtr > &pFields, const unsigned int &pNumForcingFields, const TiXmlElement *pForce)
 Initialise the forcing object. More...
 
SOLVER_UTILS_EXPORT void Apply (const Array< OneD, MultiRegions::ExpListSharedPtr > &fields, const Array< OneD, Array< OneD, NekDouble > > &inarray, Array< OneD, Array< OneD, NekDouble > > &outarray, const NekDouble &time)
 Apply the forcing. More...
 
SOLVER_UTILS_EXPORT void PreApply (const Array< OneD, MultiRegions::ExpListSharedPtr > &fields, const Array< OneD, Array< OneD, NekDouble > > &inarray, Array< OneD, Array< OneD, NekDouble > > &outarray, const NekDouble &time)
 Change the advection velocity before applying the forcing. For example, subtracting the frame velocity from the advection velocity in the MovingRefercenceFrame. More...
 
SOLVER_UTILS_EXPORT void ApplyCoeff (const Array< OneD, MultiRegions::ExpListSharedPtr > &fields, const Array< OneD, Array< OneD, NekDouble > > &inarray, Array< OneD, Array< OneD, NekDouble > > &outarray, const NekDouble &time)
 Apply the forcing. More...
 
SOLVER_UTILS_EXPORT const Array< OneD, const Array< OneD, NekDouble > > & GetForces ()
 
SOLVER_UTILS_EXPORT Array< OneD, Array< OneD, NekDouble > > & UpdateForces ()
 
- Protected Attributes inherited from Nektar::SolverUtils::Forcing
LibUtilities::SessionReaderSharedPtr m_session
 Session reader. More...
 
const std::weak_ptr< EquationSystemm_equ
 Weak pointer to equation system using this forcing. More...
 
Array< OneD, Array< OneD, NekDouble > > m_Forcing
 Evaluated forcing function. More...
 
int m_NumVariable
 Number of variables. More...
 
std::map< std::string, SolverUtils::SessionFunctionSharedPtrm_sessionFunctions
 Map of known SessionFunctions. More...
 

Detailed Description

Definition at line 48 of file ForcingBody.h.

Constructor & Destructor Documentation

◆ ForcingBody()

Nektar::SolverUtils::ForcingBody::ForcingBody ( const LibUtilities::SessionReaderSharedPtr pSession,
const std::weak_ptr< EquationSystem > &  pEquation 
)
private

Definition at line 50 of file ForcingBody.cpp.

52 : Forcing(pSession, pEquation), m_hasTimeFcnScaling(false)
53{
54}
SOLVER_UTILS_EXPORT Forcing(const LibUtilities::SessionReaderSharedPtr &pSession, const std::weak_ptr< EquationSystem > &pEquation)
Constructor.
Definition: Forcing.cpp:47

◆ ~ForcingBody()

Nektar::SolverUtils::ForcingBody::~ForcingBody ( void  )
overrideprivatedefault

Member Function Documentation

◆ create()

static SOLVER_UTILS_EXPORT ForcingSharedPtr Nektar::SolverUtils::ForcingBody::create ( const LibUtilities::SessionReaderSharedPtr pSession,
const std::weak_ptr< EquationSystem > &  pEquation,
const Array< OneD, MultiRegions::ExpListSharedPtr > &  pFields,
const unsigned int &  pNumForcingFields,
const TiXmlElement *  pForce 
)
inlinestatic

Creates an instance of this class.

Definition at line 54 of file ForcingBody.h.

59 {
62 p->InitObject(pFields, pNumForcingFields, pForce);
63 return p;
64 }
static std::shared_ptr< DataType > AllocateSharedPtr(const Args &...args)
Allocate a shared pointer from the memory pool.
SOLVER_UTILS_EXPORT typedef std::shared_ptr< Forcing > ForcingSharedPtr
A shared pointer to an EquationSystem object.
Definition: Forcing.h:53

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

◆ Update()

void Nektar::SolverUtils::ForcingBody::Update ( const Array< OneD, MultiRegions::ExpListSharedPtr > &  pFields,
const Array< OneD, Array< OneD, NekDouble > > &  inarray,
const NekDouble time 
)
private

Definition at line 163 of file ForcingBody.cpp.

166{
167 std::vector<Array<OneD, const NekDouble>> fielddata;
168 int nq = pFields[0]->GetNpoints();
169 if (m_hasEvars)
170 {
171 Array<OneD, NekDouble> xc(nq), yc(nq), zc(nq), t(nq, time);
172 pFields[0]->GetCoords(xc, yc, zc);
173 fielddata.push_back(xc);
174 fielddata.push_back(yc);
175 fielddata.push_back(zc);
176 fielddata.push_back(t);
177 }
178
179 for (const auto &it : m_eqnEvars)
180 {
181 int i = it.first;
182 if (it.second.size() > 0)
183 {
184 // Coupled forcing, reset fielddata for each equation
185 fielddata.resize(4);
186 for (int j : it.second)
187 {
188 if (m_homogeneous && pFields[i]->GetWaveSpace())
189 {
190 Array<OneD, NekDouble> tmp(nq);
191 pFields[i]->HomogeneousBwdTrans(nq, inarray[j], tmp);
192 fielddata.push_back(tmp);
193 }
194 else
195 {
196 fielddata.push_back(inarray[j]);
197 }
198 }
199 m_session->GetFunction(m_funcName, m_session->GetVariable(i))
200 ->Evaluate(fielddata, m_Forcing[i]);
201 }
202 else
203 {
204 GetFunction(pFields, m_session, m_funcName, true)
205 ->Evaluate(m_session->GetVariable(i), m_Forcing[i], time);
206 }
207
208 // If homogeneous expansion is used, transform the forcing term to
209 // be in the Fourier space
210 if (m_homogeneous)
211 {
212 pFields[i]->HomogeneousFwdTrans(pFields[i]->GetTotPoints(),
213 m_Forcing[i], m_Forcing[i]);
214 }
215 }
216}
std::map< int, std::vector< int > > m_eqnEvars
Definition: ForcingBody.h:94
Array< OneD, Array< OneD, NekDouble > > m_Forcing
Evaluated forcing function.
Definition: Forcing.h:127
SOLVER_UTILS_EXPORT SessionFunctionSharedPtr GetFunction(const Array< OneD, MultiRegions::ExpListSharedPtr > &pFields, const LibUtilities::SessionReaderSharedPtr &pSession, std::string pName, bool pCache=false)
Get a SessionFunction by name.
Definition: Forcing.cpp:150
LibUtilities::SessionReaderSharedPtr m_session
Session reader.
Definition: Forcing.h:123

References Nektar::SolverUtils::Forcing::GetFunction(), m_eqnEvars, Nektar::SolverUtils::Forcing::m_Forcing, m_funcName, m_hasEvars, m_homogeneous, and Nektar::SolverUtils::Forcing::m_session.

Referenced by v_Apply(), v_ApplyCoeff(), and v_InitObject().

◆ v_Apply()

void Nektar::SolverUtils::ForcingBody::v_Apply ( const Array< OneD, MultiRegions::ExpListSharedPtr > &  fields,
const Array< OneD, Array< OneD, NekDouble > > &  inarray,
Array< OneD, Array< OneD, NekDouble > > &  outarray,
const NekDouble time 
)
overrideprotectedvirtual

Implements Nektar::SolverUtils::Forcing.

Definition at line 218 of file ForcingBody.cpp.

222{
224 {
225 Array<OneD, NekDouble> TimeFcn(1);
226 EvaluateTimeFunction(time, m_timeFcnEqn, TimeFcn);
227
228 for (const auto &it : m_eqnEvars)
229 {
230 int i = it.first;
231 Vmath::Svtvp(outarray[i].size(), TimeFcn[0], m_Forcing[i], 1,
232 outarray[i], 1, outarray[i], 1);
233 }
234 }
235 else
236 {
237 Update(fields, inarray, time);
238
239 for (const auto &it : m_eqnEvars)
240 {
241 int i = it.first;
242 Vmath::Vadd(outarray[i].size(), outarray[i], 1, m_Forcing[i], 1,
243 outarray[i], 1);
244 }
245 }
246}
void Update(const Array< OneD, MultiRegions::ExpListSharedPtr > &pFields, const Array< OneD, Array< OneD, NekDouble > > &inarray, const NekDouble &time)
LibUtilities::EquationSharedPtr m_timeFcnEqn
Definition: ForcingBody.h:91
SOLVER_UTILS_EXPORT void EvaluateTimeFunction(LibUtilities::SessionReaderSharedPtr pSession, std::string pFieldName, Array< OneD, NekDouble > &pArray, const std::string &pFunctionName, NekDouble pTime=NekDouble(0))
Definition: Forcing.cpp:126
void Svtvp(int n, const T alpha, const T *x, const int incx, const T *y, const int incy, T *z, const int incz)
Svtvp (scalar times vector plus vector): z = alpha*x + y.
Definition: Vmath.hpp:396
void Vadd(int n, const T *x, const int incx, const T *y, const int incy, T *z, const int incz)
Add vector z = x+y.
Definition: Vmath.hpp:180

References Nektar::SolverUtils::Forcing::EvaluateTimeFunction(), m_eqnEvars, Nektar::SolverUtils::Forcing::m_Forcing, m_hasTimeFcnScaling, m_timeFcnEqn, Vmath::Svtvp(), Update(), and Vmath::Vadd().

◆ v_ApplyCoeff()

void Nektar::SolverUtils::ForcingBody::v_ApplyCoeff ( const Array< OneD, MultiRegions::ExpListSharedPtr > &  fields,
const Array< OneD, Array< OneD, NekDouble > > &  inarray,
Array< OneD, Array< OneD, NekDouble > > &  outarray,
const NekDouble time 
)
overrideprotectedvirtual

Reimplemented from Nektar::SolverUtils::Forcing.

Definition at line 248 of file ForcingBody.cpp.

252{
253 int ncoeff = outarray[m_NumVariable - 1].size();
254 Array<OneD, NekDouble> tmp(ncoeff, 0.0);
255
257 {
258 Array<OneD, NekDouble> TimeFcn(1);
259 EvaluateTimeFunction(time, m_timeFcnEqn, TimeFcn);
260
261 for (const auto &it : m_eqnEvars)
262 {
263 int i = it.first;
264 fields[i]->FwdTrans(m_Forcing[i], tmp);
265 Vmath::Svtvp(ncoeff, TimeFcn[0], tmp, 1, outarray[i], 1,
266 outarray[i], 1);
267 }
268 }
269 else
270 {
271 Update(fields, inarray, time);
272
273 for (const auto &it : m_eqnEvars)
274 {
275 int i = it.first;
276 fields[i]->FwdTrans(m_Forcing[i], tmp);
277 Vmath::Vadd(ncoeff, outarray[i], 1, tmp, 1, outarray[i], 1);
278 }
279 }
280}
int m_NumVariable
Number of variables.
Definition: Forcing.h:129

References Nektar::SolverUtils::Forcing::EvaluateTimeFunction(), m_eqnEvars, Nektar::SolverUtils::Forcing::m_Forcing, m_hasTimeFcnScaling, Nektar::SolverUtils::Forcing::m_NumVariable, m_timeFcnEqn, Vmath::Svtvp(), Update(), and Vmath::Vadd().

◆ v_InitObject()

void Nektar::SolverUtils::ForcingBody::v_InitObject ( const Array< OneD, MultiRegions::ExpListSharedPtr > &  pFields,
const unsigned int &  pNumForcingFields,
const TiXmlElement *  pForce 
)
overrideprotectedvirtual

Implements Nektar::SolverUtils::Forcing.

Definition at line 56 of file ForcingBody.cpp.

59{
60 m_NumVariable = pNumForcingFields;
61
62 const TiXmlElement *funcNameElmt = pForce->FirstChildElement("BODYFORCE");
63 if (!funcNameElmt)
64 {
65 funcNameElmt = pForce->FirstChildElement("FIELDFORCE");
66
67 ASSERTL0(funcNameElmt,
68 "Requires BODYFORCE or FIELDFORCE tag "
69 "specifying function name which prescribes body force.");
70 }
71
72 m_funcName = funcNameElmt->GetText();
73 ASSERTL0(m_session->DefinesFunction(m_funcName),
74 "Function '" + m_funcName + "' not defined.");
75
76 m_homogeneous = pFields[0]->GetExpType() == MultiRegions::e3DH1D ||
77 pFields[0]->GetExpType() == MultiRegions::e3DH2D;
78
79 // Time function is optional
80 funcNameElmt = pForce->FirstChildElement("BODYFORCETIMEFCN");
81 if (!funcNameElmt)
82 {
83 funcNameElmt = pForce->FirstChildElement("FIELDFORCETIMEFCN");
84 }
85
86 // Load time function if specified
87 if (funcNameElmt)
88 {
89 std::string funcNameTime = funcNameElmt->GetText();
90
91 ASSERTL0(!funcNameTime.empty(),
92 "Expression must be given in BODYFORCETIMEFCN or "
93 "FIELDFORCETIMEFCN.");
94
96 m_session->GetInterpreter(), funcNameTime);
97
99 }
100
101 Array<OneD, Array<OneD, NekDouble>> tmp(m_NumVariable);
102 for (int i = 0; i < m_NumVariable; ++i)
103 {
104 tmp[i] = pFields[i]->GetPhys();
105 }
106
107 std::map<std::string, int> varIndex;
108 for (int i = 0; i < m_NumVariable; ++i)
109 {
110 varIndex[m_session->GetVariable(i)] = i;
111 if (m_session->DefinesFunction(m_funcName, m_session->GetVariable(i)))
112 {
113 m_eqnEvars[i] = std::vector<int>();
114 }
115 }
116 m_hasEvars = false;
117 for (auto &it : m_eqnEvars)
118 {
119 std::string varStr = m_session->GetVariable(it.first);
121 m_session->GetFunctionType(m_funcName, varStr))
122 {
124 m_session->GetFunction(m_funcName, varStr);
125 std::string vlist = eqn->GetVlist();
126 if (!boost::iequals(vlist, "x y z t"))
127 {
128 // Coupled forcing
129 m_hasEvars = true;
130 std::vector<std::string> vars;
131 boost::split(vars, vlist, boost::is_any_of(", "));
132 for (size_t j = 4; j < vars.size(); ++j)
133 {
134 if (vars[j].size() != 0 &&
135 varIndex.find(vars[j]) == varIndex.end())
136 {
138 "Variable '" + vars[j] +
139 "' cannot be used as equation variable in "
140 "the body force '" +
141 m_funcName + "'.");
142 }
143 if (vars[j].size() &&
144 varIndex.find(vars[j]) != varIndex.end())
145 {
146 it.second.push_back(varIndex[vars[j]]);
147 }
148 }
149 }
150 }
151 }
152
153 m_Forcing = Array<OneD, Array<OneD, NekDouble>>(m_NumVariable);
154 for (const auto &it : m_eqnEvars)
155 {
156 m_Forcing[it.first] =
157 Array<OneD, NekDouble>(pFields[0]->GetTotPoints(), 0.0);
158 }
159
160 Update(pFields, tmp, 0.0);
161}
#define ASSERTL0(condition, msg)
Definition: ErrorUtil.hpp:208
#define NEKERROR(type, msg)
Assert Level 0 – Fundamental assert which is used whether in FULLDEBUG, DEBUG or OPT compilation mode...
Definition: ErrorUtil.hpp:202
std::shared_ptr< Equation > EquationSharedPtr
Definition: Equation.h:125

References Nektar::MemoryManager< DataType >::AllocateSharedPtr(), ASSERTL0, Nektar::MultiRegions::e3DH1D, Nektar::MultiRegions::e3DH2D, Nektar::ErrorUtil::efatal, Nektar::LibUtilities::eFunctionTypeExpression, m_eqnEvars, Nektar::SolverUtils::Forcing::m_Forcing, m_funcName, m_hasEvars, m_hasTimeFcnScaling, m_homogeneous, Nektar::SolverUtils::Forcing::m_NumVariable, Nektar::SolverUtils::Forcing::m_session, m_timeFcnEqn, NEKERROR, and Update().

Friends And Related Function Documentation

◆ MemoryManager< ForcingBody >

friend class MemoryManager< ForcingBody >
friend

Definition at line 1 of file ForcingBody.h.

Member Data Documentation

◆ classNameBody

std::string Nektar::SolverUtils::ForcingBody::classNameBody
static
Initial value:
=
"Body Forcing")
tKey RegisterCreatorFunction(tKey idKey, CreatorFunction classCreator, std::string pDesc="")
Register a class with the factory.
static SOLVER_UTILS_EXPORT ForcingSharedPtr create(const LibUtilities::SessionReaderSharedPtr &pSession, const std::weak_ptr< EquationSystem > &pEquation, const Array< OneD, MultiRegions::ExpListSharedPtr > &pFields, const unsigned int &pNumForcingFields, const TiXmlElement *pForce)
Creates an instance of this class.
Definition: ForcingBody.h:54
ForcingFactory & GetForcingFactory()
Declaration of the forcing factory singleton.
Definition: Forcing.cpp:41

Name of the class.

Definition at line 67 of file ForcingBody.h.

◆ classNameField

std::string Nektar::SolverUtils::ForcingBody::classNameField
static
Initial value:

Definition at line 68 of file ForcingBody.h.

◆ m_eqnEvars

std::map<int, std::vector<int> > Nektar::SolverUtils::ForcingBody::m_eqnEvars
private

Definition at line 94 of file ForcingBody.h.

Referenced by Update(), v_Apply(), v_ApplyCoeff(), and v_InitObject().

◆ m_funcName

std::string Nektar::SolverUtils::ForcingBody::m_funcName
private

Definition at line 89 of file ForcingBody.h.

Referenced by Update(), and v_InitObject().

◆ m_hasEvars

bool Nektar::SolverUtils::ForcingBody::m_hasEvars
private

Definition at line 93 of file ForcingBody.h.

Referenced by Update(), and v_InitObject().

◆ m_hasTimeFcnScaling

bool Nektar::SolverUtils::ForcingBody::m_hasTimeFcnScaling
private

Definition at line 90 of file ForcingBody.h.

Referenced by v_Apply(), v_ApplyCoeff(), and v_InitObject().

◆ m_homogeneous

bool Nektar::SolverUtils::ForcingBody::m_homogeneous
private

Definition at line 92 of file ForcingBody.h.

Referenced by Update(), and v_InitObject().

◆ m_timeFcnEqn

LibUtilities::EquationSharedPtr Nektar::SolverUtils::ForcingBody::m_timeFcnEqn
private

Definition at line 91 of file ForcingBody.h.

Referenced by v_Apply(), v_ApplyCoeff(), and v_InitObject().