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

Static Public Attributes

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

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 ASSERTL0, m_fld, m_index, m_outputFile, m_outputFrequency, m_outputIndex, and Nektar::SolverUtils::Filter::m_session.

:
Filter(pSession)
{
if (pParams.find("OutputFile") == pParams.end())
{
m_outputFile = m_session->GetSessionName();
}
else
{
ASSERTL0(!(pParams.find("OutputFile")->second.empty()),
"Missing parameter 'OutputFile'.");
m_outputFile = pParams.find("OutputFile")->second;
}
ASSERTL0(pParams.find("OutputFrequency") != pParams.end(),
"Missing parameter 'OutputFrequency'.");
m_outputFrequency = atoi(pParams.find("OutputFrequency")->second.c_str());
m_index = 0;
}
Nektar::SolverUtils::FilterCheckpoint::~FilterCheckpoint ( )

Definition at line 68 of file FilterCheckpoint.cpp.

{
}

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.

{
//p->InitObject();
return p;
}
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.

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

{
m_index = 0;
}
bool Nektar::SolverUtils::FilterCheckpoint::v_IsTimeDependent ( )
protectedvirtual

Implements Nektar::SolverUtils::Filter.

Definition at line 113 of file FilterCheckpoint.cpp.

{
return true;
}
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.

{
{
return;
}
std::stringstream vOutputFilename;
vOutputFilename << m_outputFile << "_" << m_outputIndex << ".chk";
std::vector<LibUtilities::FieldDefinitionsSharedPtr> FieldDef
= pFields[0]->GetFieldDefinitions();
std::vector<std::vector<NekDouble> > FieldData(FieldDef.size());
// copy Data into FieldData and set variable
for(int j = 0; j < pFields.num_elements(); ++j)
{
for(int i = 0; i < FieldDef.size(); ++i)
{
// Could do a search here to find correct variable
FieldDef[i]->m_fields.push_back(m_session->GetVariable(j));
pFields[0]->AppendFieldData(FieldDef[i], FieldData[i], pFields[j]->UpdateCoeffs());
}
}
m_fld->Write(vOutputFilename.str(),FieldDef,FieldData);
m_outputIndex++;
}

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