Nektar::FilterCheckpointCellModel Class Reference

#include <FilterCheckpointCellModel.h>

Inheritance diagram for Nektar::FilterCheckpointCellModel:

Collaboration diagram for Nektar::FilterCheckpointCellModel:

Public Member Functions
	FilterCheckpointCellModel (const LibUtilities::SessionReaderSharedPtr &pSession, const ParamMap &pParams)
	~FilterCheckpointCellModel ()
void	SetCellModel (CellModelSharedPtr &pCellModel)
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 SolverUtils::FilterSharedPtr	create (const LibUtilities::SessionReaderSharedPtr &pSession, 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
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
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

Detailed Description

Definition at line 45 of file FilterCheckpointCellModel.h.

Constructor & Destructor Documentation

Nektar::FilterCheckpointCellModel::FilterCheckpointCellModel	(	const LibUtilities::SessionReaderSharedPtr &	pSession,
		const ParamMap &	pParams
	)

Definition at line 44 of file FilterCheckpointCellModel.cpp.

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

                             :
    Filter(pSession)
{
    ParamMap::const_iterator it;

    // OutputFile
    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, it->second);
    m_outputFrequency = floor(equ.Evaluate());

    m_outputIndex = 0;
    m_index = 0;
    m_fld = LibUtilities::FieldIO::CreateDefault(m_session);
}

Nektar::FilterCheckpointCellModel::~FilterCheckpointCellModel

(

)

Definition at line 74 of file FilterCheckpointCellModel.cpp.

{

}

Member Function Documentation

static SolverUtils::FilterSharedPtr Nektar::FilterCheckpointCellModel::create ( const LibUtilities::SessionReaderSharedPtr &  pSession, const ParamMap &  pParams  )

inlinestatic

Creates an instance of this class.

Definition at line 51 of file FilterCheckpointCellModel.h.

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

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

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

inline

Definition at line 69 of file FilterCheckpointCellModel.h.

References m_cell.

Referenced by Nektar::Bidomain::v_InitObject(), Nektar::BidomainRoth::v_InitObject(), and Nektar::Monodomain::v_InitObject().

    {
        m_cell = pCellModel;
    }

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

protectedvirtual

Implements Nektar::SolverUtils::Filter.

Definition at line 135 of file FilterCheckpointCellModel.cpp.

{

}

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

protectedvirtual

Implements Nektar::SolverUtils::Filter.

Definition at line 79 of file FilterCheckpointCellModel.cpp.

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

{
    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);
}

bool Nektar::FilterCheckpointCellModel::v_IsTimeDependent ( )

protectedvirtual

Implements Nektar::SolverUtils::Filter.

Definition at line 142 of file FilterCheckpointCellModel.cpp.

{
    return true;
}

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

protectedvirtual

Implements Nektar::SolverUtils::Filter.

Definition at line 92 of file FilterCheckpointCellModel.cpp.

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

Referenced by v_Initialise().

{
    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(int j = 1; j < m_cell->GetNumCellVariables(); ++j)
    {
        varName = m_cell->GetCellVarName(j);

        for(int 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++;
}

Friends And Related Function Documentation

friend class MemoryManager< FilterCheckpointCellModel >

friend

Definition at line 48 of file FilterCheckpointCellModel.h.

Member Data Documentation

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.

CellModelSharedPtr Nektar::FilterCheckpointCellModel::m_cell

private

Definition at line 91 of file FilterCheckpointCellModel.h.

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

LibUtilities::FieldIOSharedPtr Nektar::FilterCheckpointCellModel::m_fld

private

Definition at line 92 of file FilterCheckpointCellModel.h.

Referenced by FilterCheckpointCellModel(), and v_Update().

unsigned int Nektar::FilterCheckpointCellModel::m_index

private

Definition at line 87 of file FilterCheckpointCellModel.h.

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

std::string Nektar::FilterCheckpointCellModel::m_outputFile

private

Definition at line 90 of file FilterCheckpointCellModel.h.

Referenced by FilterCheckpointCellModel(), and v_Update().

unsigned int Nektar::FilterCheckpointCellModel::m_outputFrequency

private

Definition at line 89 of file FilterCheckpointCellModel.h.

Referenced by FilterCheckpointCellModel(), and v_Update().

unsigned int Nektar::FilterCheckpointCellModel::m_outputIndex

private

Definition at line 88 of file FilterCheckpointCellModel.h.

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