Nektar::FilterOffsetPhase Class Reference

#include <FilterOffsetPhase.h>

Inheritance diagram for Nektar::FilterOffsetPhase:

Public Member Functions
	FilterOffsetPhase (const LibUtilities::SessionReaderSharedPtr &pSession, const std::weak_ptr< SolverUtils::EquationSystem > &pEquation, const ParamMap &pParams)
	~FilterOffsetPhase () 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 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
unsigned int	m_index
unsigned int	m_outputIndex
unsigned int	m_outputFrequency
std::string	m_outputFile
CellModelSharedPtr	m_cell
LibUtilities::FieldIOSharedPtr	m_fld
double	meanV = -57.2986
Array< OneD, NekDouble >	oldV

Friends
class	MemoryManager< FilterOffsetPhase >

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 47 of file FilterOffsetPhase.h.

Constructor & Destructor Documentation

FilterOffsetPhase()

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

Definition at line 44 of file FilterOffsetPhase.cpp.

    : Filter(pSession, pEquation)
{
    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'.");
    LibUtilities::Equation equ(m_session->GetInterpreter(),
                               pParams.find("OutputFrequency")->second);
    m_outputFrequency = floor(equ.Evaluate());
 
    if (pParams.find("MeanV") != pParams.end())
    {
        LibUtilities::Equation equ(m_session->GetInterpreter(),
                                   pParams.find("MeanV")->second);
        meanV = equ.Evaluate();
    }
 
    m_outputIndex = 0;
    m_index       = 0;
    m_fld         = LibUtilities::FieldIO::CreateDefault(pSession);
}

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

~FilterOffsetPhase()

Nektar::FilterOffsetPhase::~FilterOffsetPhase ( )

override

Definition at line 78 of file FilterOffsetPhase.cpp.

{
}

Member Function Documentation

create()

static SolverUtils::FilterSharedPtr Nektar::FilterOffsetPhase::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 53 of file FilterOffsetPhase.h.

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

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

v_Finalise()

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

overrideprotectedvirtual

Implements Nektar::SolverUtils::Filter.

Definition at line 145 of file FilterOffsetPhase.cpp.

{
}

v_Initialise()

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

overrideprotectedvirtual

Implements Nektar::SolverUtils::Filter.

Definition at line 82 of file FilterOffsetPhase.cpp.

{
    m_index       = 0;
    m_outputIndex = 0;
 
    oldV = pFields[0]->GetPhys(); // Allocate storage for past data
 
    v_Update(pFields, 0.0);
}

References m_index, m_outputIndex, oldV, and v_Update().

v_IsTimeDependent()

bool Nektar::FilterOffsetPhase::v_IsTimeDependent ( )

overrideprotectedvirtual

Implements Nektar::SolverUtils::Filter.

Definition at line 152 of file FilterOffsetPhase.cpp.

{
    return true;
}

v_Update()

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

overrideprotectedvirtual

Implements Nektar::SolverUtils::Filter.

Definition at line 94 of file FilterOffsetPhase.cpp.

{
    if (m_index++ % m_outputFrequency > 0)
    {
        return;
    }
 
    std::stringstream vOutputFilename;
    vOutputFilename << m_outputFile << "_" << m_outputIndex << ".chk";
 
    // Get FieldDefinitions
    std::vector<LibUtilities::FieldDefinitionsSharedPtr> FieldDef =
        pFields[0]->GetFieldDefinitions();
    std::vector<std::vector<NekDouble>> FieldData(FieldDef.size());
 
    Array<OneD, NekDouble> currentV = pFields[0]->GetPhys();
    Array<OneD, NekDouble> phase(currentV.size());
    Array<OneD, NekDouble> phase_coeff(pFields[0]->GetNcoeffs());
 
    // Calculate phase angle in physical space:
    for (int i = 0; i < currentV.size(); ++i)
    {
        phase[i] = atan2(currentV[i] - meanV,
                         oldV[i] - meanV); // subtract mean -57.2986
    }
 
    // Convert to coefficient space:
    pFields[0]->FwdTransLocalElmt(phase, phase_coeff);
 
    // for each item in FieldDef
    //        push "phase" to FieldDef[i]->m_fields
    //        call AppendFieldData(FieldDef[i], FieldData[i], data)
    for (int i = 0; i < FieldDef.size(); ++i)
    {
        FieldDef[i]->m_fields.push_back("phase");
        pFields[0]->AppendFieldData(FieldDef[i], FieldData[i], phase_coeff);
    }
 
    // Save currentV
    oldV = currentV;
 
    // 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_fld, m_index, m_outputFile, m_outputFrequency, m_outputIndex, meanV, and oldV.

Referenced by v_Initialise().

Friends And Related Function Documentation

MemoryManager< FilterOffsetPhase >

friend class MemoryManager< FilterOffsetPhase >

friend

Definition at line 1 of file FilterOffsetPhase.h.

Member Data Documentation

className

std::string Nektar::FilterOffsetPhase::className

static

Initial value:

=
    SolverUtils::GetFilterFactory().RegisterCreatorFunction(
        "OffsetPhase", FilterOffsetPhase::create)

Name of the class.

Definition at line 65 of file FilterOffsetPhase.h.

m_cell

CellModelSharedPtr Nektar::FilterOffsetPhase::m_cell

private

Definition at line 90 of file FilterOffsetPhase.h.

m_fld

LibUtilities::FieldIOSharedPtr Nektar::FilterOffsetPhase::m_fld

private

Definition at line 91 of file FilterOffsetPhase.h.

Referenced by FilterOffsetPhase(), and v_Update().

m_index

unsigned int Nektar::FilterOffsetPhase::m_index

private

Definition at line 86 of file FilterOffsetPhase.h.

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

m_outputFile

std::string Nektar::FilterOffsetPhase::m_outputFile

private

Definition at line 89 of file FilterOffsetPhase.h.

Referenced by FilterOffsetPhase(), and v_Update().

m_outputFrequency

unsigned int Nektar::FilterOffsetPhase::m_outputFrequency

private

Definition at line 88 of file FilterOffsetPhase.h.

Referenced by FilterOffsetPhase(), and v_Update().

m_outputIndex

unsigned int Nektar::FilterOffsetPhase::m_outputIndex

private

Definition at line 87 of file FilterOffsetPhase.h.

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

meanV

double Nektar::FilterOffsetPhase::meanV = -57.2986

private

Definition at line 92 of file FilterOffsetPhase.h.

Referenced by FilterOffsetPhase(), and v_Update().

oldV

Array<OneD, NekDouble> Nektar::FilterOffsetPhase::oldV

private

Definition at line 94 of file FilterOffsetPhase.h.

Referenced by v_Initialise(), and v_Update().