Nektar++
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator 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)
 

Private Attributes

bool m_hasTimeFcnScaling
 
LibUtilities::EquationSharedPtr m_timeFcnEqn
 

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...
 
- 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 89 of file ForcingBody.h.

89 {};

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(), and Nektar::SolverUtils::ForcingSharedPtr.

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::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 137 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(), and Vmath::Vadd().

142  {
143 
145  {
146  Array<OneD, NekDouble> TimeFcn(1);
147 
148  for (int i = 0; i < m_NumVariable; i++)
149  {
150  EvaluateTimeFunction(time, m_timeFcnEqn, TimeFcn);
151 
152  Vmath::Svtvp(outarray[i].num_elements(), TimeFcn[0],
153  m_Forcing[i], 1,
154  outarray[i], 1,
155  outarray[i], 1);
156  }
157  }
158  else
159  {
160  for (int i = 0; i < m_NumVariable; i++)
161  {
162  Vmath::Vadd(outarray[i].num_elements(), outarray[i], 1,
163  m_Forcing[i], 1, outarray[i], 1);
164  }
165  }
166  }
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:121
Array< OneD, Array< OneD, NekDouble > > m_Forcing
Evaluated forcing function.
Definition: Forcing.h:97
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:471
int m_NumVariable
Number of variables.
Definition: Forcing.h:99
LibUtilities::EquationSharedPtr m_timeFcnEqn
Definition: ForcingBody.h:92
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:285
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::SolverUtils::Forcing::EvaluateFunction(), Nektar::SolverUtils::Forcing::m_Forcing, m_hasTimeFcnScaling, Nektar::SolverUtils::Forcing::m_NumVariable, Nektar::SolverUtils::Forcing::m_session, and m_timeFcnEqn.

66  {
67  m_NumVariable = pNumForcingFields;
68  int nq = pFields[0]->GetTotPoints();
69 
70  const TiXmlElement* funcNameElmt = pForce->FirstChildElement("BODYFORCE");
71  if(!funcNameElmt)
72  {
73  funcNameElmt = pForce->FirstChildElement("FIELDFORCE");
74 
75  ASSERTL0(funcNameElmt, "Requires BODYFORCE or FIELDFORCE tag "
76  "specifying function name which prescribes body force.");
77  }
78 
79  string funcName = funcNameElmt->GetText();
80  ASSERTL0(m_session->DefinesFunction(funcName),
81  "Function '" + funcName + "' not defined.");
82 
83  // Time function is optional
84  funcNameElmt = pForce->FirstChildElement("BODYFORCETIMEFCN");
85  if(!funcNameElmt)
86  {
87  funcNameElmt = pForce->FirstChildElement("FIELDFORCETIMEFCN");
88  }
89 
90  // Load time function if specified
91  if(funcNameElmt)
92  {
93  std::string funcNameTime = funcNameElmt->GetText();
94 
95  ASSERTL0(!funcNameTime.empty(),
96  "Expression must be given in BODYFORCETIMEFCN or "
97  "FIELDFORCETIMEFCN.");
98 
99  m_session->SubstituteExpressions(funcNameTime);
101  ::AllocateSharedPtr(m_session,funcNameTime);
102 
103  m_hasTimeFcnScaling = true;
104  }
105 
106  m_Forcing = Array<OneD, Array<OneD, NekDouble> > (m_NumVariable);
107 
108  std::string s_FieldStr;
109 
110  for (int i = 0; i < m_NumVariable; ++i)
111  {
112  m_Forcing[i] = Array<OneD, NekDouble> (nq, 0.0);
113  s_FieldStr = m_session->GetVariable(i);
114  ASSERTL0(m_session->DefinesFunction(funcName, s_FieldStr),
115  "Variable '" + s_FieldStr + "' not defined.");
116  EvaluateFunction(pFields, m_session, s_FieldStr,
117  m_Forcing[i], funcName);
118  }
119 
120  bool singleMode, halfMode;
121  m_session->MatchSolverInfo("ModeType","SingleMode",singleMode,false);
122  m_session->MatchSolverInfo("ModeType","HalfMode", halfMode, false);
123  bool homogeneous = pFields[0]->GetExpType() == MultiRegions::e3DH1D;
124 
125  // If singleMode or halfMode, transform the forcing term to be in
126  // physical space in the plane, but Fourier space in the homogeneous
127  // direction
128  if (singleMode || halfMode || homogeneous)
129  {
130  for (int i = 0; i < m_NumVariable; ++i)
131  {
132  pFields[0]->HomogeneousFwdTrans(m_Forcing[i],m_Forcing[i]);
133  }
134  }
135  }
Array< OneD, Array< OneD, NekDouble > > m_Forcing
Evaluated forcing function.
Definition: Forcing.h:97
#define ASSERTL0(condition, msg)
Definition: ErrorUtil.hpp:161
static boost::shared_ptr< DataType > AllocateSharedPtr()
Allocate a shared pointer from the memory pool.
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:151
LibUtilities::SessionReaderSharedPtr m_session
Session reader.
Definition: Forcing.h:95
int m_NumVariable
Number of variables.
Definition: Forcing.h:99
LibUtilities::EquationSharedPtr m_timeFcnEqn
Definition: ForcingBody.h:92

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.

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 92 of file ForcingBody.h.

Referenced by v_Apply(), and v_InitObject().