Nektar::SolverUtils::FilterCheckpoint Class Reference

#include <FilterCheckpoint.h>

Inheritance diagram for Nektar::SolverUtils::FilterCheckpoint:

Public Member Functions
SOLVER_UTILS_EXPORT	FilterCheckpoint (const LibUtilities::SessionReaderSharedPtr &pSession, const std::weak_ptr< EquationSystem > &pEquation, const ParamMap &pParams)
SOLVER_UTILS_EXPORT	~FilterCheckpoint () override
Public Member Functions inherited from Nektar::SolverUtils::Filter
SOLVER_UTILS_EXPORT	Filter (const LibUtilities::SessionReaderSharedPtr &pSession, const std::weak_ptr< EquationSystem > &pEquation)
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::weak_ptr< EquationSystem > &pEquation, const std::map< std::string, std::string > &pParams)
	Creates an instance of this class. More...

Static Public Attributes
static std::string	className
	Name of the class. More...

Protected Member Functions
void	v_Initialise (const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time) override
void	v_Update (const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time) override
void	v_Finalise (const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time) override
bool	v_IsTimeDependent () override
virtual void	v_Initialise (const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time)=0
virtual void	v_Update (const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time)=0
virtual void	v_Finalise (const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time)=0
virtual bool	v_IsTimeDependent ()=0

Private Attributes
unsigned int	m_index
unsigned int	m_outputIndex
unsigned int	m_outputFrequency
std::string	m_outputFile
NekDouble	m_outputStartTime
LibUtilities::FieldIOSharedPtr	m_fld

Friends
class	MemoryManager< FilterCheckpoint >

Additional Inherited Members
Public Types inherited from Nektar::SolverUtils::Filter
typedef std::map< std::string, std::string >	ParamMap
Protected Attributes inherited from Nektar::SolverUtils::Filter
LibUtilities::SessionReaderSharedPtr	m_session
const std::weak_ptr< EquationSystem >	m_equ

Detailed Description

Definition at line 42 of file FilterCheckpoint.h.

Constructor & Destructor Documentation

FilterCheckpoint()

Nektar::SolverUtils::FilterCheckpoint::FilterCheckpoint	(	const LibUtilities::SessionReaderSharedPtr &	pSession,
		const std::weak_ptr< EquationSystem > &	pEquation,
		const ParamMap &	pParams
	)

Definition at line 43 of file FilterCheckpoint.cpp.

    : Filter(pSession, pEquation)
{
    // OutputFile
    auto it = pParams.find("OutputFile");
    if (it == pParams.end())
    {
        m_outputFile = m_session->GetSessionName();
    }
    else
    {
        ASSERTL0(it->second.length() > 0, "Empty parameter 'OutputFile'.");
        m_outputFile = it->second;
    }
 
    // OutputFrequency
    it = pParams.find("OutputFrequency");
    ASSERTL0(it != pParams.end(), "Missing parameter 'OutputFrequency'.");
    LibUtilities::Equation equ(m_session->GetInterpreter(), it->second);
    m_outputFrequency = round(equ.Evaluate());
 
    // Time after which we need to write checkfiles
    it = pParams.find("OutputStartTime");
    if (it == pParams.end())
    {
        m_outputStartTime = 0;
    }
    else
    {
        LibUtilities::Equation equ(m_session->GetInterpreter(), it->second);
        m_outputStartTime = equ.Evaluate();
    }
 
    m_fld = LibUtilities::FieldIO::CreateDefault(pSession);
}

References ASSERTL0, Nektar::LibUtilities::FieldIO::CreateDefault(), Nektar::LibUtilities::Equation::Evaluate(), m_fld, m_outputFile, m_outputFrequency, m_outputStartTime, and Nektar::SolverUtils::Filter::m_session.

~FilterCheckpoint()

Nektar::SolverUtils::FilterCheckpoint::~FilterCheckpoint ( )

override

Definition at line 81 of file FilterCheckpoint.cpp.

{
}

Member Function Documentation

create()

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

inlinestatic

Creates an instance of this class.

Definition at line 48 of file FilterCheckpoint.h.

    {
        FilterSharedPtr p = MemoryManager<FilterCheckpoint>::AllocateSharedPtr(
            pSession, pEquation, pParams);
        return p;
    }

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

v_Finalise()

void Nektar::SolverUtils::FilterCheckpoint::v_Finalise ( const Array< OneD, const MultiRegions::ExpListSharedPtr > &  pFields, const NekDouble &  time  )

overrideprotectedvirtual

Implements Nektar::SolverUtils::Filter.

Definition at line 126 of file FilterCheckpoint.cpp.

{
}

v_Initialise()

void Nektar::SolverUtils::FilterCheckpoint::v_Initialise ( const Array< OneD, const MultiRegions::ExpListSharedPtr > &  pFields, const NekDouble &  time  )

overrideprotectedvirtual

Implements Nektar::SolverUtils::Filter.

Definition at line 85 of file FilterCheckpoint.cpp.

{
    m_index       = 0;
    m_outputIndex = 0;
    v_Update(pFields, time);
}

References m_index, m_outputIndex, and v_Update().

v_IsTimeDependent()

bool Nektar::SolverUtils::FilterCheckpoint::v_IsTimeDependent ( )

overrideprotectedvirtual

Implements Nektar::SolverUtils::Filter.

Definition at line 133 of file FilterCheckpoint.cpp.

{
    return true;
}

v_Update()

void Nektar::SolverUtils::FilterCheckpoint::v_Update ( const Array< OneD, const MultiRegions::ExpListSharedPtr > &  pFields, const NekDouble &  time  )

overrideprotectedvirtual

Implements Nektar::SolverUtils::Filter.

Definition at line 94 of file FilterCheckpoint.cpp.

{
 
    if (m_index++ % m_outputFrequency > 0 || time < m_outputStartTime)
    {
        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.size(); ++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++;
}

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

Referenced by v_Initialise().

Friends And Related Function Documentation

MemoryManager< FilterCheckpoint >

friend class MemoryManager< FilterCheckpoint >

friend

Definition at line 1 of file FilterCheckpoint.h.

Member Data Documentation

className

std::string Nektar::SolverUtils::FilterCheckpoint::className

static

Initial value:

=
    GetFilterFactory().RegisterCreatorFunction("Checkpoint",
                                               FilterCheckpoint::create)

Name of the class.

Definition at line 59 of file FilterCheckpoint.h.

m_fld

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

private

Definition at line 86 of file FilterCheckpoint.h.

Referenced by FilterCheckpoint(), and v_Update().

m_index

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

private

Definition at line 80 of file FilterCheckpoint.h.

Referenced by v_Initialise(), and v_Update().

m_outputFile

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

private

Definition at line 83 of file FilterCheckpoint.h.

Referenced by FilterCheckpoint(), and v_Update().

m_outputFrequency

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

private

Definition at line 82 of file FilterCheckpoint.h.

Referenced by FilterCheckpoint(), and v_Update().

m_outputIndex

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

private

Definition at line 81 of file FilterCheckpoint.h.

Referenced by v_Initialise(), and v_Update().

m_outputStartTime

NekDouble Nektar::SolverUtils::FilterCheckpoint::m_outputStartTime

private

Definition at line 85 of file FilterCheckpoint.h.

Referenced by FilterCheckpoint(), and v_Update().