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

#include <FilterCheckpoint.h>

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

Public Member Functions

SOLVER_UTILS_EXPORT FilterCheckpoint (const LibUtilities::SessionReaderSharedPtr &pSession, const std::map< std::string, std::string > &pParams)
 
virtual SOLVER_UTILS_EXPORT ~FilterCheckpoint ()
 
- Public Member Functions inherited from Nektar::SolverUtils::Filter
SOLVER_UTILS_EXPORT Filter (const LibUtilities::SessionReaderSharedPtr &pSession)
 
virtual SOLVER_UTILS_EXPORT ~Filter ()
 
SOLVER_UTILS_EXPORT void Initialise (const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time)
 
SOLVER_UTILS_EXPORT void Update (const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time)
 
SOLVER_UTILS_EXPORT void Finalise (const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time)
 
SOLVER_UTILS_EXPORT bool IsTimeDependent ()
 

Static Public Member Functions

static FilterSharedPtr create (const LibUtilities::SessionReaderSharedPtr &pSession, const std::map< std::string, std::string > &pParams)
 Creates an instance of this class. More...
 

Static Public Attributes

static std::string className = GetFilterFactory().RegisterCreatorFunction("Checkpoint", FilterCheckpoint::create)
 Name of the class. More...
 

Protected Member Functions

virtual void v_Initialise (const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time)
 
virtual void v_Update (const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time)
 
virtual void v_Finalise (const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time)
 
virtual bool v_IsTimeDependent ()
 

Private Attributes

unsigned int m_index
 
unsigned int m_outputIndex
 
unsigned int m_outputFrequency
 
std::string m_outputFile
 
LibUtilities::FieldIOSharedPtr m_fld
 

Friends

class MemoryManager< FilterCheckpoint >
 

Additional Inherited Members

- Protected Attributes inherited from Nektar::SolverUtils::Filter
LibUtilities::SessionReaderSharedPtr m_session
 

Detailed Description

Definition at line 45 of file FilterCheckpoint.h.

Constructor & Destructor Documentation

Nektar::SolverUtils::FilterCheckpoint::FilterCheckpoint ( const LibUtilities::SessionReaderSharedPtr pSession,
const std::map< std::string, std::string > &  pParams 
)

Definition at line 44 of file FilterCheckpoint.cpp.

References Nektar::MemoryManager< DataType >::AllocateSharedPtr(), ASSERTL0, m_fld, m_index, m_outputFile, m_outputFrequency, m_outputIndex, and Nektar::SolverUtils::Filter::m_session.

46  :
47  Filter(pSession)
48  {
49  if (pParams.find("OutputFile") == pParams.end())
50  {
51  m_outputFile = m_session->GetSessionName();
52  }
53  else
54  {
55  ASSERTL0(!(pParams.find("OutputFile")->second.empty()),
56  "Missing parameter 'OutputFile'.");
57  m_outputFile = pParams.find("OutputFile")->second;
58  }
59  ASSERTL0(pParams.find("OutputFrequency") != pParams.end(),
60  "Missing parameter 'OutputFrequency'.");
61  m_outputFrequency = atoi(pParams.find("OutputFrequency")->second.c_str());
62  m_outputIndex = 0;
63  m_index = 0;
65 
66  }
#define ASSERTL0(condition, msg)
Definition: ErrorUtil.hpp:135
SOLVER_UTILS_EXPORT Filter(const LibUtilities::SessionReaderSharedPtr &pSession)
Definition: Filter.cpp:52
static boost::shared_ptr< DataType > AllocateSharedPtr()
Allocate a shared pointer from the memory pool.
LibUtilities::FieldIOSharedPtr m_fld
LibUtilities::SessionReaderSharedPtr m_session
Definition: Filter.h:76
Nektar::SolverUtils::FilterCheckpoint::~FilterCheckpoint ( )
virtual

Definition at line 68 of file FilterCheckpoint.cpp.

69  {
70 
71  }

Member Function Documentation

static FilterSharedPtr Nektar::SolverUtils::FilterCheckpoint::create ( const LibUtilities::SessionReaderSharedPtr pSession,
const std::map< std::string, std::string > &  pParams 
)
inlinestatic

Creates an instance of this class.

Definition at line 51 of file FilterCheckpoint.h.

References Nektar::MemoryManager< DataType >::AllocateSharedPtr().

53  {
55  //p->InitObject();
56  return p;
57  }
static boost::shared_ptr< DataType > AllocateSharedPtr()
Allocate a shared pointer from the memory pool.
boost::shared_ptr< Filter > FilterSharedPtr
A shared pointer to a Driver object.
Definition: Filter.h:50
void Nektar::SolverUtils::FilterCheckpoint::v_Finalise ( const Array< OneD, const MultiRegions::ExpListSharedPtr > &  pFields,
const NekDouble time 
)
protectedvirtual

Implements Nektar::SolverUtils::Filter.

Definition at line 108 of file FilterCheckpoint.cpp.

109  {
110 
111  }
void Nektar::SolverUtils::FilterCheckpoint::v_Initialise ( const Array< OneD, const MultiRegions::ExpListSharedPtr > &  pFields,
const NekDouble time 
)
protectedvirtual

Implements Nektar::SolverUtils::Filter.

Definition at line 73 of file FilterCheckpoint.cpp.

References m_index, and m_outputIndex.

74  {
75  m_index = 0;
76  m_outputIndex = 0;
77  }
bool Nektar::SolverUtils::FilterCheckpoint::v_IsTimeDependent ( )
protectedvirtual

Implements Nektar::SolverUtils::Filter.

Definition at line 113 of file FilterCheckpoint.cpp.

114  {
115  return true;
116  }
void Nektar::SolverUtils::FilterCheckpoint::v_Update ( const Array< OneD, const MultiRegions::ExpListSharedPtr > &  pFields,
const NekDouble time 
)
protectedvirtual

Implements Nektar::SolverUtils::Filter.

Definition at line 79 of file FilterCheckpoint.cpp.

References m_fld, m_index, m_outputFile, m_outputFrequency, m_outputIndex, and Nektar::SolverUtils::Filter::m_session.

80  {
81  m_index++;
82  if (m_index % m_outputFrequency > 0)
83  {
84  return;
85  }
86 
87  std::stringstream vOutputFilename;
88  vOutputFilename << m_outputFile << "_" << m_outputIndex << ".chk";
89 
90  std::vector<LibUtilities::FieldDefinitionsSharedPtr> FieldDef
91  = pFields[0]->GetFieldDefinitions();
92  std::vector<std::vector<NekDouble> > FieldData(FieldDef.size());
93 
94  // copy Data into FieldData and set variable
95  for(int j = 0; j < pFields.num_elements(); ++j)
96  {
97  for(int i = 0; i < FieldDef.size(); ++i)
98  {
99  // Could do a search here to find correct variable
100  FieldDef[i]->m_fields.push_back(m_session->GetVariable(j));
101  pFields[0]->AppendFieldData(FieldDef[i], FieldData[i], pFields[j]->UpdateCoeffs());
102  }
103  }
104  m_fld->Write(vOutputFilename.str(),FieldDef,FieldData);
105  m_outputIndex++;
106  }
LibUtilities::FieldIOSharedPtr m_fld
LibUtilities::SessionReaderSharedPtr m_session
Definition: Filter.h:76

Friends And Related Function Documentation

friend class MemoryManager< FilterCheckpoint >
friend

Definition at line 48 of file FilterCheckpoint.h.

Member Data Documentation

std::string Nektar::SolverUtils::FilterCheckpoint::className = GetFilterFactory().RegisterCreatorFunction("Checkpoint", FilterCheckpoint::create)
static

Name of the class.

Definition at line 60 of file FilterCheckpoint.h.

LibUtilities::FieldIOSharedPtr Nektar::SolverUtils::FilterCheckpoint::m_fld
private

Definition at line 78 of file FilterCheckpoint.h.

Referenced by FilterCheckpoint(), and v_Update().

unsigned int Nektar::SolverUtils::FilterCheckpoint::m_index
private

Definition at line 74 of file FilterCheckpoint.h.

Referenced by FilterCheckpoint(), v_Initialise(), and v_Update().

std::string Nektar::SolverUtils::FilterCheckpoint::m_outputFile
private

Definition at line 77 of file FilterCheckpoint.h.

Referenced by FilterCheckpoint(), and v_Update().

unsigned int Nektar::SolverUtils::FilterCheckpoint::m_outputFrequency
private

Definition at line 76 of file FilterCheckpoint.h.

Referenced by FilterCheckpoint(), and v_Update().

unsigned int Nektar::SolverUtils::FilterCheckpoint::m_outputIndex
private

Definition at line 75 of file FilterCheckpoint.h.

Referenced by FilterCheckpoint(), v_Initialise(), and v_Update().