Nektar++
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
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:
Inheritance graph
[legend]
Collaboration diagram for Nektar::SolverUtils::ForcingBody:
Collaboration graph
[legend]

Static Public Member Functions

static SOLVER_UTILS_EXPORT
ForcingSharedPtr 
create (const LibUtilities::SessionReaderSharedPtr &pSession, 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< ForcingSharedPtr
Load (const LibUtilities::SessionReaderSharedPtr &pSession, 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

virtual SOLVER_UTILS_EXPORT void v_InitObject (const Array< OneD, MultiRegions::ExpListSharedPtr > &pFields, const unsigned int &pNumForcingFields, const TiXmlElement *pForce)
 
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)
 
- Protected Member Functions inherited from Nektar::SolverUtils::Forcing
SOLVER_UTILS_EXPORT Forcing (const LibUtilities::SessionReaderSharedPtr &)
 Constructor. More...
 
SOLVER_UTILS_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))
 
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)
 
virtual ~ForcingBody (void)
 
void Update (const Array< OneD, MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time)
 

Private Attributes

std::string m_funcName
 
bool m_hasTimeFcnScaling
 
LibUtilities::EquationSharedPtr m_timeFcnEqn
 
bool m_transform
 

Friends

class MemoryManager< ForcingBody >
 

Additional Inherited Members

- Public Member Functions inherited from Nektar::SolverUtils::Forcing
virtual SOLVER_UTILS_EXPORT ~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 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...
 
Array< OneD, Array< OneD,
NekDouble > > 
m_Forcing
 Evaluated forcing function. More...
 
int m_NumVariable
 Number of variables. More...
 

Detailed Description

Definition at line 52 of file ForcingBody.h.

Constructor & Destructor Documentation

Nektar::SolverUtils::ForcingBody::ForcingBody ( const LibUtilities::SessionReaderSharedPtr pSession)
private

Definition at line 55 of file ForcingBody.cpp.

57  : Forcing(pSession),
58  m_hasTimeFcnScaling(false)
59  {
60  }
SOLVER_UTILS_EXPORT Forcing(const LibUtilities::SessionReaderSharedPtr &)
Constructor.
Definition: Forcing.cpp:53
virtual Nektar::SolverUtils::ForcingBody::~ForcingBody ( void  )
inlineprivatevirtual

Definition at line 95 of file ForcingBody.h.

95 {};

Member Function Documentation

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

Creates an instance of this class.

Definition at line 59 of file ForcingBody.h.

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

64  {
66  AllocateSharedPtr(pSession);
67  p->InitObject(pFields, pNumForcingFields, pForce);
68  return p;
69  }
static boost::shared_ptr< DataType > AllocateSharedPtr()
Allocate a shared pointer from the memory pool.
SOLVER_UTILS_EXPORT typedef boost::shared_ptr< Forcing > ForcingSharedPtr
A shared pointer to an EquationSystem object.
Definition: Forcing.h:51
void Nektar::SolverUtils::ForcingBody::Update ( const Array< OneD, MultiRegions::ExpListSharedPtr > &  pFields,
const NekDouble time 
)
private

Definition at line 123 of file ForcingBody.cpp.

References ASSERTL0, Nektar::SolverUtils::Forcing::EvaluateFunction(), Nektar::SolverUtils::Forcing::m_Forcing, m_funcName, Nektar::SolverUtils::Forcing::m_NumVariable, Nektar::SolverUtils::Forcing::m_session, and m_transform.

Referenced by v_Apply(), and v_InitObject().

126  {
127  for (int i = 0; i < m_NumVariable; ++i)
128  {
129  std::string s_FieldStr = m_session->GetVariable(i);
130  ASSERTL0(m_session->DefinesFunction(m_funcName, s_FieldStr),
131  "Variable '" + s_FieldStr + "' not defined.");
132  EvaluateFunction(pFields, m_session, s_FieldStr,
133  m_Forcing[i], m_funcName, time);
134  }
135 
136  // If singleMode or halfMode, transform the forcing term to be in
137  // physical space in the plane, but Fourier space in the homogeneous
138  // direction
139  if (m_transform)
140  {
141  for (int i = 0; i < m_NumVariable; ++i)
142  {
143  pFields[0]->HomogeneousFwdTrans(m_Forcing[i], m_Forcing[i]);
144  }
145  }
146  }
Array< OneD, Array< OneD, NekDouble > > m_Forcing
Evaluated forcing function.
Definition: Forcing.h:102
#define ASSERTL0(condition, msg)
Definition: ErrorUtil.hpp:198
SOLVER_UTILS_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))
Definition: Forcing.cpp:161
LibUtilities::SessionReaderSharedPtr m_session
Session reader.
Definition: Forcing.h:100
int m_NumVariable
Number of variables.
Definition: Forcing.h:104
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 
)
protectedvirtual

Implements Nektar::SolverUtils::Forcing.

Definition at line 149 of file ForcingBody.cpp.

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

154  {
156  {
157  Array<OneD, NekDouble> TimeFcn(1);
158 
159  for (int i = 0; i < m_NumVariable; i++)
160  {
161  EvaluateTimeFunction(time, m_timeFcnEqn, TimeFcn);
162 
163  Vmath::Svtvp(outarray[i].num_elements(), TimeFcn[0],
164  m_Forcing[i], 1,
165  outarray[i], 1,
166  outarray[i], 1);
167  }
168  }
169  else
170  {
171  Update(fields, time);
172 
173  for (int i = 0; i < m_NumVariable; i++)
174  {
175  Vmath::Vadd(outarray[i].num_elements(), outarray[i], 1,
176  m_Forcing[i], 1, outarray[i], 1);
177  }
178  }
179  }
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:131
Array< OneD, Array< OneD, NekDouble > > m_Forcing
Evaluated forcing function.
Definition: Forcing.h:102
void Update(const Array< OneD, MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time)
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.cpp:485
int m_NumVariable
Number of variables.
Definition: Forcing.h:104
LibUtilities::EquationSharedPtr m_timeFcnEqn
Definition: ForcingBody.h:90
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.cpp:299
void Nektar::SolverUtils::ForcingBody::v_InitObject ( const Array< OneD, MultiRegions::ExpListSharedPtr > &  pFields,
const unsigned int &  pNumForcingFields,
const TiXmlElement *  pForce 
)
protectedvirtual

Implements Nektar::SolverUtils::Forcing.

Definition at line 62 of file ForcingBody.cpp.

References Nektar::MemoryManager< DataType >::AllocateSharedPtr(), ASSERTL0, Nektar::MultiRegions::e3DH1D, Nektar::MultiRegions::e3DH2D, Nektar::SolverUtils::Forcing::m_Forcing, m_funcName, m_hasTimeFcnScaling, Nektar::SolverUtils::Forcing::m_NumVariable, Nektar::SolverUtils::Forcing::m_session, m_timeFcnEqn, m_transform, and Update().

66  {
67  m_NumVariable = pNumForcingFields;
68 
69  const TiXmlElement* funcNameElmt = pForce->FirstChildElement("BODYFORCE");
70  if(!funcNameElmt)
71  {
72  funcNameElmt = pForce->FirstChildElement("FIELDFORCE");
73 
74  ASSERTL0(funcNameElmt, "Requires BODYFORCE or FIELDFORCE tag "
75  "specifying function name which prescribes body force.");
76  }
77 
78  m_funcName = funcNameElmt->GetText();
79  ASSERTL0(m_session->DefinesFunction(m_funcName),
80  "Function '" + m_funcName + "' not defined.");
81 
82  bool singleMode, halfMode;
83  m_session->MatchSolverInfo("ModeType","SingleMode",singleMode,false);
84  m_session->MatchSolverInfo("ModeType","HalfMode", halfMode, false);
85  bool homogeneous = pFields[0]->GetExpType() == MultiRegions::e3DH1D ||
86  pFields[0]->GetExpType() == MultiRegions::e3DH2D;
87  m_transform = (singleMode || halfMode || homogeneous);
88 
89  // Time function is optional
90  funcNameElmt = pForce->FirstChildElement("BODYFORCETIMEFCN");
91  if(!funcNameElmt)
92  {
93  funcNameElmt = pForce->FirstChildElement("FIELDFORCETIMEFCN");
94  }
95 
96  // Load time function if specified
97  if(funcNameElmt)
98  {
99  std::string funcNameTime = funcNameElmt->GetText();
100 
101  ASSERTL0(!funcNameTime.empty(),
102  "Expression must be given in BODYFORCETIMEFCN or "
103  "FIELDFORCETIMEFCN.");
104 
105  m_session->SubstituteExpressions(funcNameTime);
107  ::AllocateSharedPtr(m_session,funcNameTime);
108 
109  m_hasTimeFcnScaling = true;
110  }
111 
112  m_Forcing = Array<OneD, Array<OneD, NekDouble> > (m_NumVariable);
113  for (int i = 0; i < m_NumVariable; ++i)
114  {
115  m_Forcing[i] = Array<OneD, NekDouble> (pFields[0]->GetTotPoints(), 0.0);
116  }
117 
118 
119  Update(pFields, 0.0);
120  }
Array< OneD, Array< OneD, NekDouble > > m_Forcing
Evaluated forcing function.
Definition: Forcing.h:102
#define ASSERTL0(condition, msg)
Definition: ErrorUtil.hpp:198
static boost::shared_ptr< DataType > AllocateSharedPtr()
Allocate a shared pointer from the memory pool.
void Update(const Array< OneD, MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time)
LibUtilities::SessionReaderSharedPtr m_session
Session reader.
Definition: Forcing.h:100
int m_NumVariable
Number of variables.
Definition: Forcing.h:104
LibUtilities::EquationSharedPtr m_timeFcnEqn
Definition: ForcingBody.h:90

Friends And Related Function Documentation

friend class MemoryManager< ForcingBody >
friend

Definition at line 56 of file ForcingBody.h.

Member Data Documentation

std::string Nektar::SolverUtils::ForcingBody::classNameBody
static
Initial value:
RegisterCreatorFunction("Body",
"Body Forcing")

Name of the class.

Definition at line 72 of file ForcingBody.h.

std::string Nektar::SolverUtils::ForcingBody::classNameField
static
Initial value:
RegisterCreatorFunction("Field",
"Field Forcing")

Definition at line 73 of file ForcingBody.h.

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

Definition at line 88 of file ForcingBody.h.

Referenced by Update(), and v_InitObject().

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

Definition at line 89 of file ForcingBody.h.

Referenced by v_Apply(), and v_InitObject().

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

Definition at line 90 of file ForcingBody.h.

Referenced by v_Apply(), and v_InitObject().

bool Nektar::SolverUtils::ForcingBody::m_transform
private

Definition at line 91 of file ForcingBody.h.

Referenced by Update(), and v_InitObject().