Nektar++
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Nektar::SolverUtils::Forcing Class Referenceabstract

Defines a forcing term to be explicitly applied. More...

#include <Forcing.h>

Inheritance diagram for Nektar::SolverUtils::Forcing:
Inheritance graph
[legend]
Collaboration diagram for Nektar::SolverUtils::Forcing:
Collaboration graph
[legend]

Public Member Functions

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...
 

Static Public Member Functions

static SOLVER_UTILS_EXPORT
std::vector< ForcingSharedPtr > 		Load (const LibUtilities::SessionReaderSharedPtr &pSession, const Array< OneD, MultiRegions::ExpListSharedPtr > &pFields, const unsigned int &pNumForcingFields=0)
 

Protected Member Functions

SOLVER_UTILS_EXPORT Forcing (const LibUtilities::SessionReaderSharedPtr &)
 Constructor. More...
 
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
 
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)
 

Protected Attributes

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

Defines a forcing term to be explicitly applied.

Definition at line 70 of file Forcing.h.

Constructor & Destructor Documentation

virtual SOLVER_UTILS_EXPORT Nektar::SolverUtils::Forcing::~Forcing ( )
inlinevirtual

Definition at line 73 of file Forcing.h.

73 {}
Nektar::SolverUtils::Forcing::Forcing ( const LibUtilities::SessionReaderSharedPtr &  pSession)
protected

Constructor.

Definition at line 53 of file Forcing.cpp.

54  : m_session(pSession)
55  {
56 
57  }
Nektar::SolverUtils::Forcing::m_session
LibUtilities::SessionReaderSharedPtr m_session
Session reader.
Definition: Forcing.h:95

Member Function Documentation

void Nektar::SolverUtils::Forcing::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.

Parameters
fieldsExpansion lists corresponding to input arrays
inarrayu^n from previous timestep
outarrayoutput array to append forcing to

Definition at line 73 of file Forcing.cpp.

References v_Apply().

78  {
79  v_Apply(fields, inarray, outarray, time);
80  }
Nektar::SolverUtils::Forcing::v_Apply
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
void Nektar::SolverUtils::Forcing::EvaluateFunction ( Array< OneD, MultiRegions::ExpListSharedPtr >  pFields,
LibUtilities::SessionReaderSharedPtr  pSession,
std::string  pFieldName,
Array< OneD, NekDouble > &  pArray,
const std::string &  pFunctionName,
NekDouble  pTime = NekDouble(0) 
)
protected

Definition at line 151 of file Forcing.cpp.

References Nektar::MemoryManager< DataType >::AllocateSharedPtr(), ASSERTL0, Nektar::LibUtilities::eFunctionTypeExpression, Nektar::LibUtilities::eFunctionTypeFile, m_session, and Vmath::Zero().

Referenced by Nektar::ForcingMovingBody::v_Apply(), Nektar::SolverUtils::ForcingBody::v_InitObject(), and Nektar::SolverUtils::ForcingAbsorption::v_InitObject().

158  {
159  ASSERTL0(pSession->DefinesFunction(pFunctionName),
160  "Function '" + pFunctionName + "' does not exist.");
161 
162  unsigned int nq = pFields[0]->GetNpoints();
163  if (pArray.num_elements() != nq)
164  {
165  pArray = Array<OneD, NekDouble> (nq);
166  }
167 
168  LibUtilities::FunctionType vType;
169  vType = pSession->GetFunctionType(pFunctionName, pFieldName);
170  if (vType == LibUtilities::eFunctionTypeExpression)
171  {
172  Array<OneD, NekDouble> x0(nq);
173  Array<OneD, NekDouble> x1(nq);
174  Array<OneD, NekDouble> x2(nq);
175 
176  pFields[0]->GetCoords(x0, x1, x2);
177  LibUtilities::EquationSharedPtr ffunc =
178  pSession->GetFunction(pFunctionName, pFieldName);
179 
180  ffunc->Evaluate(x0, x1, x2, pTime, pArray);
181  }
182  else if (vType == LibUtilities::eFunctionTypeFile)
183  {
184  std::string filename = pSession->GetFunctionFilename(
185  pFunctionName,
186  pFieldName);
187 
188  std::vector<LibUtilities::FieldDefinitionsSharedPtr> FieldDef;
189  std::vector<std::vector<NekDouble> > FieldData;
190  Array<OneD, NekDouble> vCoeffs(pFields[0]->GetNcoeffs());
191  Vmath::Zero(vCoeffs.num_elements(), vCoeffs, 1);
192 
193  LibUtilities::FieldIOSharedPtr fld =
194  MemoryManager<LibUtilities::FieldIO>::AllocateSharedPtr(m_session->GetComm());
195  fld->Import(filename, FieldDef, FieldData);
196 
197  int idx = -1;
198  for (int i = 0; i < FieldDef.size(); ++i)
199  {
200  for (int j = 0; j < FieldDef[i]->m_fields.size(); ++j)
201  {
202  if (FieldDef[i]->m_fields[j] == pFieldName)
203  {
204  idx = j;
205  }
206  }
207 
208  if (idx >= 0)
209  {
210  pFields[0]->ExtractDataToCoeffs(
211  FieldDef[i],
212  FieldData[i],
213  FieldDef[i]->m_fields[idx],
214  vCoeffs);
215  }
216  else
217  {
218  cout << "Field " + pFieldName + " not found." << endl;
219  }
220  }
221  pFields[0]->BwdTrans_IterPerExp(vCoeffs, pArray);
222  }
223  }
ASSERTL0
#define ASSERTL0(condition, msg)
Definition: ErrorUtil.hpp:188
Nektar::MemoryManager::AllocateSharedPtr
static boost::shared_ptr< DataType > AllocateSharedPtr()
Allocate a shared pointer from the memory pool.
Definition: NekMemoryManager.hpp:235
Nektar::LibUtilities::FieldIOSharedPtr
boost::shared_ptr< FieldIO > FieldIOSharedPtr
Definition: FieldIO.h:225
Nektar::SolverUtils::Forcing::m_session
LibUtilities::SessionReaderSharedPtr m_session
Session reader.
Definition: Forcing.h:95
Nektar::LibUtilities::EquationSharedPtr
boost::shared_ptr< Equation > EquationSharedPtr
Definition: SessionReader.h:100
Vmath::Zero
void Zero(int n, T *x, const int incx)
Zero vector.
Definition: Vmath.cpp:359
void Nektar::SolverUtils::Forcing::EvaluateTimeFunction ( LibUtilities::SessionReaderSharedPtr  pSession,
std::string  pFieldName,
Array< OneD, NekDouble > &  pArray,
const std::string &  pFunctionName,
NekDouble  pTime = NekDouble(0) 
)
protected

Definition at line 121 of file Forcing.cpp.

References ASSERTL0.

Referenced by Nektar::SolverUtils::ForcingBody::v_Apply(), and Nektar::SolverUtils::ForcingAbsorption::v_Apply().

127  {
128  ASSERTL0(pSession->DefinesFunction(pFunctionName),
129  "Function '" + pFunctionName + "' does not exist.");
130 
131  LibUtilities::EquationSharedPtr ffunc =
132  pSession->GetFunction(pFunctionName, pFieldName);
133 
134  EvaluateTimeFunction(pTime,ffunc,pArray);
135  }
Nektar::SolverUtils::Forcing::EvaluateTimeFunction
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
ASSERTL0
#define ASSERTL0(condition, msg)
Definition: ErrorUtil.hpp:188
Nektar::LibUtilities::EquationSharedPtr
boost::shared_ptr< Equation > EquationSharedPtr
Definition: SessionReader.h:100
void Nektar::SolverUtils::Forcing::EvaluateTimeFunction ( const NekDouble  pTime,
const LibUtilities::EquationSharedPtr &  pEqn,
Array< OneD, NekDouble > &  pArray 
)
protected

Definition at line 138 of file Forcing.cpp.

142  {
143  // dummy array of zero pts.
144  Array<OneD, NekDouble> x0(pArray.num_elements(),0.0);
145 
146  pEqn->Evaluate(x0, x0, x0, pTime, pArray);
147  }
void Nektar::SolverUtils::Forcing::InitObject ( const Array< OneD, MultiRegions::ExpListSharedPtr > &  pFields,
const unsigned int &  pNumForcingFields,
const TiXmlElement *  pForce 
)

Initialise the forcing object.

Definition at line 59 of file Forcing.cpp.

References v_InitObject().

63  {
64  v_InitObject(pFields, pNumForcingFields, pForce);
65  }
Nektar::SolverUtils::Forcing::v_InitObject
virtual SOLVER_UTILS_EXPORT void v_InitObject(const Array< OneD, MultiRegions::ExpListSharedPtr > &pFields, const unsigned int &pNumForcingFields, const TiXmlElement *pForce)=0
vector< ForcingSharedPtr > Nektar::SolverUtils::Forcing::Load ( const LibUtilities::SessionReaderSharedPtr &  pSession,
const Array< OneD, MultiRegions::ExpListSharedPtr > &  pFields,
const unsigned int &  pNumForcingFields = 0 
)
static

Definition at line 86 of file Forcing.cpp.

References Nektar::SolverUtils::GetForcingFactory().

Referenced by Nektar::IncNavierStokes::v_InitObject(), Nektar::UnsteadyViscousBurgers::v_InitObject(), and Nektar::CompressibleFlowSystem::v_InitObject().

90  {
91  vector<ForcingSharedPtr> vForceList;
92 
93  if (!pSession->DefinesElement("Nektar/Forcing"))
94  {
95  return vForceList;
96  }
97 
98  TiXmlElement* vForcing = pSession->GetElement("Nektar/Forcing");
99  if (vForcing)
100  {
101  unsigned int vNumForcingFields = pNumForcingFields;
102  if (!pNumForcingFields)
103  {
104  vNumForcingFields = pFields.num_elements();
105  }
106 
107  TiXmlElement* vForce = vForcing->FirstChildElement("FORCE");
108  while (vForce)
109  {
110  string vType = vForce->Attribute("TYPE");
111 
112  vForceList.push_back(GetForcingFactory().CreateInstance(
113  vType, pSession, pFields,
114  vNumForcingFields, vForce));
115  vForce = vForce->NextSiblingElement("FORCE");
116  }
117  }
118  return vForceList;
119  }
Nektar::SolverUtils::GetForcingFactory
ForcingFactory & GetForcingFactory()
Declaration of the forcing factory singleton.
Definition: Forcing.cpp:44
virtual SOLVER_UTILS_EXPORT void Nektar::SolverUtils::Forcing::v_Apply ( const Array< OneD, MultiRegions::ExpListSharedPtr > &  fields,
const Array< OneD, Array< OneD, NekDouble > > &  inarray,
Array< OneD, Array< OneD, NekDouble > > &  outarray,
const NekDouble &  time 
)
protectedpure virtual

Implemented in Nektar::SolverUtils::ForcingProgrammatic, Nektar::SolverUtils::ForcingAbsorption, Nektar::ForcingMovingBody, Nektar::SolverUtils::ForcingBody, Nektar::SolverUtils::ForcingNoise, and Nektar::ForcingStabilityCoupledLNS.

Referenced by Apply().

virtual SOLVER_UTILS_EXPORT void Nektar::SolverUtils::Forcing::v_InitObject ( const Array< OneD, MultiRegions::ExpListSharedPtr > &  pFields,
const unsigned int &  pNumForcingFields,
const TiXmlElement *  pForce 
)
protectedpure virtual

Implemented in Nektar::SolverUtils::ForcingProgrammatic, Nektar::SolverUtils::ForcingAbsorption, Nektar::ForcingMovingBody, Nektar::SolverUtils::ForcingBody, Nektar::SolverUtils::ForcingNoise, and Nektar::ForcingStabilityCoupledLNS.

Referenced by InitObject().

Member Data Documentation

Array<OneD, Array<OneD, NekDouble> > Nektar::SolverUtils::Forcing::m_Forcing
protected

Evaluated forcing function.

Definition at line 97 of file Forcing.h.

Referenced by Nektar::SolverUtils::ForcingProgrammatic::UpdateForces(), Nektar::SolverUtils::ForcingNoise::v_Apply(), Nektar::SolverUtils::ForcingBody::v_Apply(), Nektar::SolverUtils::ForcingAbsorption::v_Apply(), Nektar::SolverUtils::ForcingProgrammatic::v_Apply(), Nektar::SolverUtils::ForcingNoise::v_InitObject(), Nektar::SolverUtils::ForcingBody::v_InitObject(), Nektar::SolverUtils::ForcingAbsorption::v_InitObject(), and Nektar::SolverUtils::ForcingProgrammatic::v_InitObject().

int Nektar::SolverUtils::Forcing::m_NumVariable
protected

Number of variables.

Definition at line 99 of file Forcing.h.

Referenced by Nektar::SolverUtils::ForcingNoise::v_Apply(), Nektar::SolverUtils::ForcingBody::v_Apply(), Nektar::SolverUtils::ForcingAbsorption::v_Apply(), Nektar::SolverUtils::ForcingProgrammatic::v_Apply(), Nektar::SolverUtils::ForcingNoise::v_InitObject(), Nektar::SolverUtils::ForcingBody::v_InitObject(), Nektar::SolverUtils::ForcingAbsorption::v_InitObject(), and Nektar::SolverUtils::ForcingProgrammatic::v_InitObject().

LibUtilities::SessionReaderSharedPtr Nektar::SolverUtils::Forcing::m_session
protected

Session reader.

Definition at line 95 of file Forcing.h.

Referenced by Nektar::ForcingMovingBody::CheckIsFromFile(), EvaluateFunction(), Nektar::ForcingMovingBody::EvaluateStructDynModel(), Nektar::ForcingMovingBody::InitialiseCableModel(), Nektar::ForcingMovingBody::Newmark_betaSolver(), Nektar::ForcingMovingBody::SetDynEqCoeffMatrix(), Nektar::ForcingMovingBody::v_Apply(), Nektar::SolverUtils::ForcingAbsorption::v_Apply(), Nektar::SolverUtils::ForcingBody::v_InitObject(), Nektar::ForcingMovingBody::v_InitObject(), and Nektar::SolverUtils::ForcingAbsorption::v_InitObject().

Generated on Sat Jun 4 2016 00:02:45 for Nektar++ by   doxygen 1.8.8