#include <FilterThresholdMax.h>

Inheritance diagram for Nektar::SolverUtils::FilterThresholdMax:

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

SOLVER_UTILS_EXPORT	~FilterThresholdMax () 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
	Initialises the filter. More...

void	v_Update (const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time) override
	For each point in domain test if solution is above threshold. More...

void	v_Finalise (const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time) override
	Finalise the filter and write out data. More...

bool	v_IsTimeDependent () override
	Indicate that this filter is time dependent. More...

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
Array< OneD, NekDouble >	m_threshold
	Storage for recording when each point in domain rises above threshold. More...

NekDouble	m_startTime
	Time at which to start recording. More...

NekDouble	m_thresholdValue
	Value of threshold. More...

int	m_thresholdVar
	Variable on which to detect threshold. More...

NekDouble	m_initialValue
	Initial value of storage. More...

std::string	m_outputFile
	File into which to write output data. More...

LibUtilities::FieldIOSharedPtr	m_fld
	FieldIO object for writing data. More...

Friends
class	MemoryManager< FilterThresholdMax >

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 43 of file FilterThresholdMax.h.

Constructor & Destructor Documentation

◆ FilterThresholdMax()

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

Definition at line 46 of file FilterThresholdMax.cpp.

    : Filter(pSession, pEquation)
{
    // ThresholdValue
    auto it = pParams.find("ThresholdValue");
    ASSERTL0(it != pParams.end(), "Missing parameter 'ThresholdValue'.");
    LibUtilities::Equation equ1(m_session->GetInterpreter(), it->second);
    m_thresholdValue = equ1.Evaluate();
 
    // InitialValue
    it = pParams.find("InitialValue");
    ASSERTL0(it != pParams.end(), "Missing parameter 'InitialValue'.");
    LibUtilities::Equation equ2(m_session->GetInterpreter(), it->second);
    m_initialValue = equ2.Evaluate();
 
    // StartTime
    it          = pParams.find("StartTime");
    m_startTime = 0.0;
    if (it != pParams.end())
    {
        LibUtilities::Equation equ(m_session->GetInterpreter(), it->second);
        m_startTime = equ.Evaluate();
    }
 
    // OutputFile
    it           = pParams.find("OutputFile");
    m_outputFile = pSession->GetSessionName() + "_max.fld";
    if (it != pParams.end())
    {
        m_outputFile = it->second;
    }
 
    // ThresholdVar
    it             = pParams.find("ThresholdVar");
    m_thresholdVar = 0;
    if (it != pParams.end())
    {
        std::string var             = it->second.c_str();
        std::vector<string> varlist = pSession->GetVariables();
        auto x = std::find(varlist.begin(), varlist.end(), var);
        ASSERTL0(x != varlist.end(),
                 "Specified variable " + var +
                     " in ThresholdMax filter is not available.");
        m_thresholdVar = x - varlist.begin();
    }
 
    m_fld = LibUtilities::FieldIO::CreateDefault(pSession);
}

References ASSERTL0, Nektar::LibUtilities::FieldIO::CreateDefault(), Nektar::LibUtilities::Equation::Evaluate(), Nektar::StdRegions::find(), m_fld, m_initialValue, m_outputFile, Nektar::SolverUtils::Filter::m_session, m_startTime, m_thresholdValue, and m_thresholdVar.

◆ ~FilterThresholdMax()

Nektar::SolverUtils::FilterThresholdMax::~FilterThresholdMax ( )

override

Definition at line 97 of file FilterThresholdMax.cpp.

98{

99}

Member Function Documentation

◆ create()

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

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

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

◆ v_Finalise()

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

overrideprotectedvirtual

Finalise the filter and write out data.

Implements Nektar::SolverUtils::Filter.

Definition at line 132 of file FilterThresholdMax.cpp.

{
    std::vector<LibUtilities::FieldDefinitionsSharedPtr> FieldDef =
        pFields[m_thresholdVar]->GetFieldDefinitions();
    std::vector<std::vector<NekDouble>> FieldData(FieldDef.size());
 
    Array<OneD, NekDouble> vCoeffs(pFields[0]->GetNcoeffs());
    pFields[m_thresholdVar]->FwdTransLocalElmt(m_threshold, vCoeffs);
 
    // copy Data into FieldData and set variable
    for (int i = 0; i < FieldDef.size(); ++i)
    {
        // Could do a search here to find correct variable
        FieldDef[i]->m_fields.push_back("m");
        pFields[m_thresholdVar]->AppendFieldData(FieldDef[i], FieldData[i],
                                                 vCoeffs);
    }
 
    m_fld->Write(m_outputFile, FieldDef, FieldData);
}

References m_fld, m_outputFile, m_threshold, and m_thresholdVar.

◆ v_Initialise()

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

overrideprotectedvirtual

Initialises the filter.

Implements Nektar::SolverUtils::Filter.

Definition at line 101 of file FilterThresholdMax.cpp.

{
    m_threshold = Array<OneD, NekDouble>(pFields[m_thresholdVar]->GetNpoints(),
                                         m_initialValue);
}

References m_initialValue, m_threshold, and m_thresholdVar.

◆ v_IsTimeDependent()

bool Nektar::SolverUtils::FilterThresholdMax::v_IsTimeDependent ( )

overrideprotectedvirtual

Indicate that this filter is time dependent.

Implements Nektar::SolverUtils::Filter.

Definition at line 155 of file FilterThresholdMax.cpp.

{
    return true;
}

◆ v_Update()

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

overrideprotectedvirtual

For each point in domain test if solution is above threshold.

Implements Nektar::SolverUtils::Filter.

Definition at line 109 of file FilterThresholdMax.cpp.

{
    if (time < m_startTime)
    {
        return;
    }
 
    int i;
    NekDouble timestep =
        pFields[m_thresholdVar]->GetSession()->GetParameter("TimeStep");
 
    for (i = 0; i < pFields[m_thresholdVar]->GetNpoints(); ++i)
    {
        if (m_threshold[i] < timestep &&
            pFields[m_thresholdVar]->GetPhys()[i] > m_thresholdValue)
        {
            m_threshold[i] = time;
        }
    }
}

References m_startTime, m_threshold, m_thresholdValue, and m_thresholdVar.

Friends And Related Function Documentation

◆ MemoryManager< FilterThresholdMax >

friend class MemoryManager< FilterThresholdMax >

friend

Definition at line 1 of file FilterThresholdMax.h.

Member Data Documentation

◆ className

std::string Nektar::SolverUtils::FilterThresholdMax::className

static

Initial value:

=
    GetFilterFactory().RegisterCreatorFunction("ThresholdMax",
                                               FilterThresholdMax::create)

Name of the class.

Definition at line 61 of file FilterThresholdMax.h.

◆ m_fld

LibUtilities::FieldIOSharedPtr Nektar::SolverUtils::FilterThresholdMax::m_fld

private

FieldIO object for writing data.

Definition at line 99 of file FilterThresholdMax.h.

Referenced by FilterThresholdMax(), and v_Finalise().

◆ m_initialValue

NekDouble Nektar::SolverUtils::FilterThresholdMax::m_initialValue

private

Initial value of storage.

Definition at line 95 of file FilterThresholdMax.h.

Referenced by FilterThresholdMax(), and v_Initialise().

◆ m_outputFile

std::string Nektar::SolverUtils::FilterThresholdMax::m_outputFile

private

File into which to write output data.

Definition at line 97 of file FilterThresholdMax.h.

Referenced by FilterThresholdMax(), and v_Finalise().

◆ m_startTime

NekDouble Nektar::SolverUtils::FilterThresholdMax::m_startTime

private

Time at which to start recording.

Definition at line 89 of file FilterThresholdMax.h.

Referenced by FilterThresholdMax(), and v_Update().

◆ m_threshold

Array<OneD, NekDouble> Nektar::SolverUtils::FilterThresholdMax::m_threshold

private

Storage for recording when each point in domain rises above threshold.

Definition at line 87 of file FilterThresholdMax.h.

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

◆ m_thresholdValue

NekDouble Nektar::SolverUtils::FilterThresholdMax::m_thresholdValue

private

Value of threshold.

Definition at line 91 of file FilterThresholdMax.h.

Referenced by FilterThresholdMax(), and v_Update().

◆ m_thresholdVar

int Nektar::SolverUtils::FilterThresholdMax::m_thresholdVar

private

Variable on which to detect threshold.

Definition at line 93 of file FilterThresholdMax.h.

Referenced by FilterThresholdMax(), v_Finalise(), 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

◆ FilterThresholdMax()

◆ ~FilterThresholdMax()

Member Function Documentation

◆ create()

◆ v_Finalise()

◆ v_Initialise()

◆ v_IsTimeDependent()

◆ v_Update()

Friends And Related Function Documentation

◆ MemoryManager< FilterThresholdMax >

Member Data Documentation

◆ className

◆ m_fld

◆ m_initialValue

◆ m_outputFile

◆ m_startTime

◆ m_threshold

◆ m_thresholdValue

◆ m_thresholdVar