#include <FilterCheckpointCellModel.h>

Inheritance diagram for Nektar::FilterCheckpointCellModel:

Public Member Functions
	FilterCheckpointCellModel (const LibUtilities::SessionReaderSharedPtr &pSession, const std::weak_ptr< SolverUtils::EquationSystem > &pEquation, const ParamMap &pParams)

	~FilterCheckpointCellModel () override

void	SetCellModel (CellModelSharedPtr &pCellModel)

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 SolverUtils::FilterSharedPtr	create (const LibUtilities::SessionReaderSharedPtr &pSession, const std::weak_ptr< SolverUtils::EquationSystem > &pEquation, const ParamMap &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
size_t	m_index

size_t	m_outputIndex

size_t	m_outputFrequency

std::string	m_outputFile

CellModelSharedPtr	m_cell

LibUtilities::FieldIOSharedPtr	m_fld

Friends
class	MemoryManager< FilterCheckpointCellModel >

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 44 of file FilterCheckpointCellModel.h.

Constructor & Destructor Documentation

◆ FilterCheckpointCellModel()

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

Definition at line 43 of file FilterCheckpointCellModel.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, "Missing 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 = floor(equ.Evaluate());
 
    m_outputIndex = 0;
    m_index       = 0;
    m_fld         = LibUtilities::FieldIO::CreateDefault(m_session);
}

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

◆ ~FilterCheckpointCellModel()

Nektar::FilterCheckpointCellModel::~FilterCheckpointCellModel ( )

override

Definition at line 72 of file FilterCheckpointCellModel.cpp.

73{

74}

Member Function Documentation

◆ create()

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

inlinestatic

Creates an instance of this class.

Definition at line 50 of file FilterCheckpointCellModel.h.

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

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

◆ SetCellModel()

void Nektar::FilterCheckpointCellModel::SetCellModel ( CellModelSharedPtr & pCellModel )

inline

Definition at line 70 of file FilterCheckpointCellModel.h.

    {
        m_cell = pCellModel;
    }

References m_cell.

◆ v_Finalise()

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

overrideprotectedvirtual

Implements Nektar::SolverUtils::Filter.

Definition at line 133 of file FilterCheckpointCellModel.cpp.

137{

138}

◆ v_Initialise()

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

overrideprotectedvirtual

Implements Nektar::SolverUtils::Filter.

Definition at line 76 of file FilterCheckpointCellModel.cpp.

{
    ASSERTL0(m_cell.get(),
             "Cell model has not been set by EquationSystem "
             "class. Use SetCellModel on this filter to achieve this.");
 
    m_index       = 0;
    m_outputIndex = 0;
 
    v_Update(pFields, 0.0);
}

References ASSERTL0, m_cell, m_index, m_outputIndex, and v_Update().

◆ v_IsTimeDependent()

bool Nektar::FilterCheckpointCellModel::v_IsTimeDependent ( )

overrideprotectedvirtual

Implements Nektar::SolverUtils::Filter.

Definition at line 140 of file FilterCheckpointCellModel.cpp.

{
    return true;
}

◆ v_Update()

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

overrideprotectedvirtual

Implements Nektar::SolverUtils::Filter.

Definition at line 90 of file FilterCheckpointCellModel.cpp.

{
    if (m_index++ % m_outputFrequency > 0)
    {
        return;
    }
 
    std::stringstream vOutputFilename;
    vOutputFilename << m_outputFile << "_" << m_outputIndex << ".chk";
 
    SpatialDomains::MeshGraphSharedPtr vGraph = pFields[0]->GetGraph();
 
    std::vector<LibUtilities::FieldDefinitionsSharedPtr> FieldDef =
        pFields[0]->GetFieldDefinitions();
    std::vector<std::vector<NekDouble>> FieldData(FieldDef.size());
 
    // copy Data into FieldData and set variable
    std::string varName;
    for (size_t j = 1; j < m_cell->GetNumCellVariables(); ++j)
    {
        varName = m_cell->GetCellVarName(j);
 
        for (size_t i = 0; i < FieldDef.size(); ++i)
        {
            // Retrieve data from cell model
            Array<OneD, NekDouble> data = m_cell->GetCellSolutionCoeffs(j);
 
            // Could do a search here to find correct variable
            FieldDef[i]->m_fields.push_back(varName);
            pFields[0]->AppendFieldData(FieldDef[i], FieldData[i], data);
        }
    }
 
    // Update time in field info if required
    LibUtilities::FieldMetaDataMap fieldMetaDataMap;
    fieldMetaDataMap["Time"] = boost::lexical_cast<std::string>(time);
 
    m_fld->Write(vOutputFilename.str(), FieldDef, FieldData, fieldMetaDataMap);
    m_outputIndex++;
}

References m_cell, m_fld, m_index, m_outputFile, m_outputFrequency, and m_outputIndex.

Referenced by v_Initialise().

Friends And Related Function Documentation

◆ MemoryManager< FilterCheckpointCellModel >

friend class MemoryManager< FilterCheckpointCellModel >

friend

Definition at line 1 of file FilterCheckpointCellModel.h.

Member Data Documentation

◆ className

std::string Nektar::FilterCheckpointCellModel::className

static

Initial value:

=
    SolverUtils::GetFilterFactory().RegisterCreatorFunction(
        "CheckpointCellModel", FilterCheckpointCellModel::create)

Name of the class.

Definition at line 62 of file FilterCheckpointCellModel.h.

◆ m_cell

CellModelSharedPtr Nektar::FilterCheckpointCellModel::m_cell

private

Definition at line 92 of file FilterCheckpointCellModel.h.

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

◆ m_fld

LibUtilities::FieldIOSharedPtr Nektar::FilterCheckpointCellModel::m_fld

private

Definition at line 93 of file FilterCheckpointCellModel.h.

Referenced by FilterCheckpointCellModel(), and v_Update().

◆ m_index

size_t Nektar::FilterCheckpointCellModel::m_index

private

Definition at line 88 of file FilterCheckpointCellModel.h.

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

◆ m_outputFile

std::string Nektar::FilterCheckpointCellModel::m_outputFile

private

Definition at line 91 of file FilterCheckpointCellModel.h.

Referenced by FilterCheckpointCellModel(), and v_Update().

◆ m_outputFrequency

size_t Nektar::FilterCheckpointCellModel::m_outputFrequency

private

Definition at line 90 of file FilterCheckpointCellModel.h.

Referenced by FilterCheckpointCellModel(), and v_Update().

◆ m_outputIndex

size_t Nektar::FilterCheckpointCellModel::m_outputIndex

private

Definition at line 89 of file FilterCheckpointCellModel.h.

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

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FilterCheckpointCellModel()

◆ ~FilterCheckpointCellModel()

Member Function Documentation

◆ create()

◆ SetCellModel()

◆ v_Finalise()

◆ v_Initialise()

◆ v_IsTimeDependent()

◆ v_Update()

Friends And Related Function Documentation

◆ MemoryManager< FilterCheckpointCellModel >

Member Data Documentation

◆ className

◆ m_cell

◆ m_fld

◆ m_index

◆ m_outputFile

◆ m_outputFrequency

◆ m_outputIndex