Nektar::SolverUtils::FilterThresholdMax Class Reference

#include <FilterThresholdMax.h>

Inheritance diagram for Nektar::SolverUtils::FilterThresholdMax:

Collaboration diagram for Nektar::SolverUtils::FilterThresholdMax:

Public Member Functions
SOLVER_UTILS_EXPORT	FilterThresholdMax (const LibUtilities::SessionReaderSharedPtr &pSession, const ParamMap &pParams)
virtual SOLVER_UTILS_EXPORT	~FilterThresholdMax ()
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 FilterSharedPtr	create (const LibUtilities::SessionReaderSharedPtr &pSession, 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
virtual void	v_Initialise (const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time)
	Initialises the filter. More...
virtual void	v_Update (const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time)
	For each point in domain test if solution is above threshold. More...
virtual void	v_Finalise (const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time)
	Finalise the filter and write out data. More...
virtual bool	v_IsTimeDependent ()
	Indicate that this filter is time dependent. More...

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

Detailed Description

Definition at line 46 of file FilterThresholdMax.h.

Constructor & Destructor Documentation

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

Definition at line 47 of file FilterThresholdMax.cpp.

References Nektar::MemoryManager< DataType >::AllocateSharedPtr(), ASSERTL0, 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.

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

    // ThresholdValue
    it = pParams.find("ThresholdValue");
    ASSERTL0(it != pParams.end(), "Missing parameter 'ThresholdValue'.");
    LibUtilities::Equation equ1(m_session, it->second);
    m_thresholdValue = equ1.Evaluate();

    // InitialValue
    it = pParams.find("InitialValue");
    ASSERTL0(it != pParams.end(), "Missing parameter 'InitialValue'.");
    LibUtilities::Equation equ2(m_session, it->second);
    m_initialValue = equ2.Evaluate();

    // StartTime
    it = pParams.find("StartTime");
    m_startTime = 0.0;
    if (it != pParams.end())
    {
        LibUtilities::Equation equ(m_session, 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();
        std::vector<string>::const_iterator x;
        ASSERTL0((x=std::find(varlist.begin(), varlist.end(), var))
                        != varlist.end(),
                 "Specified variable " + var +
                 " in ThresholdMax filter is not available.");
        m_thresholdVar = x - varlist.begin();
    }

    m_fld = MemoryManager<LibUtilities::FieldIO>
                ::AllocateSharedPtr(pSession->GetComm());

}

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

virtual

Definition at line 103 of file FilterThresholdMax.cpp.

{

}

Member Function Documentation

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

inlinestatic

Creates an instance of this class.

Definition at line 52 of file FilterThresholdMax.h.

References Nektar::MemoryManager< DataType >::AllocateSharedPtr().

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

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

protectedvirtual

Finalise the filter and write out data.

Implements Nektar::SolverUtils::Filter.

Definition at line 138 of file FilterThresholdMax.cpp.

References m_fld, m_outputFile, m_threshold, and m_thresholdVar.

{
    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]->FwdTrans_IterPerExp(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);

}

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

protectedvirtual

Initialises the filter.

Implements Nektar::SolverUtils::Filter.

Definition at line 108 of file FilterThresholdMax.cpp.

References m_initialValue, m_threshold, and m_thresholdVar.

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

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

protectedvirtual

Indicate that this filter is time dependent.

Implements Nektar::SolverUtils::Filter.

Definition at line 161 of file FilterThresholdMax.cpp.

{
    return true;
}

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

protectedvirtual

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

Implements Nektar::SolverUtils::Filter.

Definition at line 116 of file FilterThresholdMax.cpp.

References m_startTime, m_threshold, m_thresholdValue, and m_thresholdVar.

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

Friends And Related Function Documentation

friend class MemoryManager< FilterThresholdMax >

friend

Definition at line 49 of file FilterThresholdMax.h.

Member Data Documentation

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.

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

private

FieldIO object for writing data.

Definition at line 98 of file FilterThresholdMax.h.

Referenced by FilterThresholdMax(), and v_Finalise().

NekDouble Nektar::SolverUtils::FilterThresholdMax::m_initialValue

private

Initial value of storage.

Definition at line 94 of file FilterThresholdMax.h.

Referenced by FilterThresholdMax(), and v_Initialise().

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

private

File into which to write output data.

Definition at line 96 of file FilterThresholdMax.h.

Referenced by FilterThresholdMax(), and v_Finalise().

NekDouble Nektar::SolverUtils::FilterThresholdMax::m_startTime

private

Time at which to start recording.

Definition at line 88 of file FilterThresholdMax.h.

Referenced by FilterThresholdMax(), and v_Update().

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

private

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

Definition at line 86 of file FilterThresholdMax.h.

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

NekDouble Nektar::SolverUtils::FilterThresholdMax::m_thresholdValue

private

Value of threshold.

Definition at line 90 of file FilterThresholdMax.h.

Referenced by FilterThresholdMax(), and v_Update().

int Nektar::SolverUtils::FilterThresholdMax::m_thresholdVar

private

Variable on which to detect threshold.

Definition at line 92 of file FilterThresholdMax.h.

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