#include <FilterMaxMinFields.h>

Inheritance diagram for Nektar::SolverUtils::FilterMaxMinFields:

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

SOLVER_UTILS_EXPORT	~FilterMaxMinFields () override

Public Member Functions inherited from Nektar::SolverUtils::FilterFieldConvert
SOLVER_UTILS_EXPORT	FilterFieldConvert (const LibUtilities::SessionReaderSharedPtr &pSession, const std::weak_ptr< EquationSystem > &pEquation, const ParamMap &pParams)

SOLVER_UTILS_EXPORT	~FilterFieldConvert () 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 Member Functions inherited from Nektar::SolverUtils::FilterFieldConvert
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...

Static Public Attributes inherited from Nektar::SolverUtils::FilterFieldConvert
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_FillVariablesName (const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields) override

void	v_ProcessSample (const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, std::vector< Array< OneD, NekDouble > > &fieldcoeffs, const NekDouble &time) override

void	v_PrepareOutput (const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time) override

NekDouble	v_GetScale () override

std::string	v_GetFileSuffix () override

Protected Member Functions inherited from Nektar::SolverUtils::FilterFieldConvert
SOLVER_UTILS_EXPORT void	v_Initialise (const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time) override

virtual SOLVER_UTILS_EXPORT void	v_FillVariablesName (const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields)

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

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

virtual SOLVER_UTILS_EXPORT void	v_ProcessSample (const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, std::vector< Array< OneD, NekDouble > > &fieldcoeffs, const NekDouble &time)

virtual SOLVER_UTILS_EXPORT void	v_PrepareOutput (const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time)

virtual SOLVER_UTILS_EXPORT NekDouble	v_GetScale ()

virtual SOLVER_UTILS_EXPORT std::string	v_GetFileSuffix ()

void	OutputField (const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, int dump=-1)

SOLVER_UTILS_EXPORT bool	v_IsTimeDependent () override

void	CreateModules (std::vector< std::string > &modcmds)

void	CreateFields (const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields)

void	CheckModules (std::vector< ModuleSharedPtr > &modules)

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

Protected Attributes
bool	m_isMax

ProblemType	m_problemType

std::vector< Array< OneD, NekDouble > >	m_curFieldsPhys

std::vector< Array< OneD, NekDouble > >	m_outFieldsPhys

Protected Attributes inherited from Nektar::SolverUtils::FilterFieldConvert
unsigned int	m_numSamples

unsigned int	m_outputFrequency

unsigned int	m_sampleFrequency

std::string	m_outputFile

std::string	m_restartFile

unsigned int	m_index

unsigned int	m_outputIndex

bool	m_phaseSample

NekDouble	m_phaseSamplePeriod

NekDouble	m_phaseSamplePhase

NekDouble	m_phaseTolerance

NekDouble	m_dt

std::vector< ModuleSharedPtr >	m_modules

LibUtilities::FieldMetaDataMap	m_fieldMetaData

std::vector< Array< OneD, NekDouble > >	m_outFields

std::vector< std::string >	m_variables

FieldSharedPtr	m_f

po::variables_map	m_vm

Protected Attributes inherited from Nektar::SolverUtils::Filter
LibUtilities::SessionReaderSharedPtr	m_session

const std::weak_ptr< EquationSystem >	m_equ

Private Attributes
bool	m_initialized

Friends
class	MemoryManager< FilterMaxMinFields >

Additional Inherited Members
Public Types inherited from Nektar::SolverUtils::Filter
typedef std::map< std::string, std::string >	ParamMap

Detailed Description

Definition at line 50 of file FilterMaxMinFields.h.

Constructor & Destructor Documentation

◆ FilterMaxMinFields()

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

Definition at line 44 of file FilterMaxMinFields.cpp.

    : FilterFieldConvert(pSession, pEquation, pParams)
{
    // Load sampling frequency
    auto it = pParams.find("SampleFrequency");
    if (it == pParams.end())
    {
        m_sampleFrequency = 1;
    }
    else
    {
        LibUtilities::Equation equ(m_session->GetInterpreter(), it->second);
        m_sampleFrequency = round(equ.Evaluate());
    }
 
    // Load flag for max or min
    it                  = pParams.find("MaxOrMin");
    std::string sOption = it->second.c_str();
    if (boost::iequals(sOption, "maximum") || boost::iequals(sOption, "max"))
    {
        m_isMax = true;
    }
    else if (boost::iequals(sOption, "minimum") ||
             boost::iequals(sOption, "min"))
    {
        m_isMax = false;
    }
    else
    {
        ASSERTL1(false, "MaxOrMin needs to be max or min.");
    }
    m_initialized = m_restartFile != "";
 
    // Initialize other member vars
    m_problemType = eCompressible;
}

References ASSERTL1, Nektar::SolverUtils::eCompressible, Nektar::LibUtilities::Equation::Evaluate(), m_initialized, m_isMax, m_problemType, Nektar::SolverUtils::FilterFieldConvert::m_restartFile, Nektar::SolverUtils::FilterFieldConvert::m_sampleFrequency, and Nektar::SolverUtils::Filter::m_session.

◆ ~FilterMaxMinFields()

Nektar::SolverUtils::FilterMaxMinFields::~FilterMaxMinFields ( )

override

Definition at line 83 of file FilterMaxMinFields.cpp.

84{

85}

Member Function Documentation

◆ create()

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

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

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

◆ v_FillVariablesName()

void Nektar::SolverUtils::FilterMaxMinFields::v_FillVariablesName ( const Array< OneD, const MultiRegions::ExpListSharedPtr > & pFields )

inlineoverrideprotectedvirtual

Reimplemented from Nektar::SolverUtils::FilterFieldConvert.

Definition at line 85 of file FilterMaxMinFields.h.

    {
        FilterFieldConvert::v_FillVariablesName(pFields);
    }

References Nektar::SolverUtils::FilterFieldConvert::v_FillVariablesName().

◆ v_GetFileSuffix()

std::string Nektar::SolverUtils::FilterMaxMinFields::v_GetFileSuffix ( )

inlineoverrideprotectedvirtual

Reimplemented from Nektar::SolverUtils::FilterFieldConvert.

Definition at line 99 of file FilterMaxMinFields.h.

    {
        if (m_isMax)
        {
            return "_max";
        }
        else
        {
            return "_min";
        }
    }

References m_isMax.

◆ v_GetScale()

NekDouble Nektar::SolverUtils::FilterMaxMinFields::v_GetScale ( )

overrideprotectedvirtual

Reimplemented from Nektar::SolverUtils::FilterFieldConvert.

Definition at line 226 of file FilterMaxMinFields.cpp.

{
    return 1.0;
}

◆ v_Initialise()

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

overrideprotectedvirtual

Reimplemented from Nektar::SolverUtils::FilterFieldConvert.

Definition at line 87 of file FilterMaxMinFields.cpp.

{
    // Initialise output arrays
    FilterFieldConvert::v_Initialise(pFields, time);
 
    // Allocate storage
    int nf;
    m_curFieldsPhys.resize(m_variables.size());
    m_outFieldsPhys.resize(m_variables.size());
    for (int n = 0; n < m_variables.size(); ++n)
    {
        nf = (n < pFields.size()) ? n : 0;
        m_curFieldsPhys[n] =
            Array<OneD, NekDouble>(pFields[nf]->GetTotPoints(), 0.0);
        m_outFieldsPhys[n] =
            Array<OneD, NekDouble>(pFields[nf]->GetTotPoints(), 0.0);
    }
 
    // Check type of problem
    std::string firstVarName = pFields[0]->GetSession()->GetVariable(0);
    if (boost::iequals(firstVarName, "u"))
    {
        m_problemType = eIncompressible;
    }
    else if (boost::iequals(firstVarName, "rho"))
    {
        m_problemType = eCompressible;
    }
    else
    {
        m_problemType = eOthers;
    }
 
    if (m_initialized)
    {
        for (int n = 0; n < m_variables.size(); ++n)
        {
            int nf = (n < pFields.size()) ? n : 0;
            pFields[nf]->BwdTrans(m_outFields[n], m_outFieldsPhys[n]);
            if (pFields[nf]->GetWaveSpace())
            {
                pFields[nf]->HomogeneousBwdTrans(pFields[nf]->GetTotPoints(),
                                                 m_outFieldsPhys[n],
                                                 m_outFieldsPhys[n]);
            }
        }
    }
}

References Nektar::SolverUtils::eCompressible, Nektar::SolverUtils::eIncompressible, Nektar::SolverUtils::eOthers, m_curFieldsPhys, m_initialized, Nektar::SolverUtils::FilterFieldConvert::m_outFields, m_outFieldsPhys, m_problemType, Nektar::SolverUtils::FilterFieldConvert::m_variables, and Nektar::SolverUtils::FilterFieldConvert::v_Initialise().

◆ v_PrepareOutput()

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

overrideprotectedvirtual

Reimplemented from Nektar::SolverUtils::FilterFieldConvert.

Definition at line 218 of file FilterMaxMinFields.cpp.

{
    m_fieldMetaData["NumberOfFieldDumps"] = std::to_string(m_numSamples);
}

References Nektar::SolverUtils::FilterFieldConvert::m_fieldMetaData, and Nektar::SolverUtils::FilterFieldConvert::m_numSamples.

◆ v_ProcessSample()

void Nektar::SolverUtils::FilterMaxMinFields::v_ProcessSample	(	const Array< OneD, const MultiRegions::ExpListSharedPtr > &	pFields,
		std::vector< Array< OneD, NekDouble > > &	fieldcoeffs,
		const NekDouble &	time
	)

overrideprotectedvirtual

Reimplemented from Nektar::SolverUtils::FilterFieldConvert.

Definition at line 153 of file FilterMaxMinFields.cpp.

{
    for (int n = 0; n < m_variables.size(); ++n)
    {
        int nf = (n < pFields.size()) ? n : 0;
        pFields[nf]->BwdTrans(fieldcoeffs[n], m_curFieldsPhys[n]);
        if (pFields[nf]->GetWaveSpace())
        {
            pFields[nf]->HomogeneousBwdTrans(pFields[nf]->GetTotPoints(),
                                             m_curFieldsPhys[n],
                                             m_curFieldsPhys[n]);
        }
    }
 
    // Get max/min for each field
    if (!m_initialized)
    {
        for (int n = 0; n < m_variables.size(); ++n)
        {
            int length = m_outFieldsPhys[n].size();
            Vmath::Vcopy(length, m_curFieldsPhys[n], 1, m_outFieldsPhys[n], 1);
        }
        m_initialized = true;
    }
    else
    {
        for (int n = 0; n < m_variables.size(); ++n)
        {
            int length = m_outFieldsPhys[n].size();
            if (m_isMax)
            {
                // Compute max
                for (int i = 0; i < length; ++i)
                {
                    if (m_curFieldsPhys[n][i] > m_outFieldsPhys[n][i])
                    {
                        m_outFieldsPhys[n][i] = m_curFieldsPhys[n][i];
                    }
                }
            }
            else
            {
                // Compute min
                for (int i = 0; i < length; ++i)
                {
                    if (m_curFieldsPhys[n][i] < m_outFieldsPhys[n][i])
                    {
                        m_outFieldsPhys[n][i] = m_curFieldsPhys[n][i];
                    }
                }
            }
        }
    }
 
    // Forward transform and put into m_outFields
    for (int n = 0; n < m_variables.size(); ++n)
    {
        int nf = (n < pFields.size()) ? n : 0;
        pFields[nf]->FwdTransLocalElmt(m_outFieldsPhys[n], m_outFields[n]);
    }
}

References m_curFieldsPhys, m_initialized, m_isMax, Nektar::SolverUtils::FilterFieldConvert::m_outFields, m_outFieldsPhys, Nektar::SolverUtils::FilterFieldConvert::m_variables, and Vmath::Vcopy().

Friends And Related Function Documentation

◆ MemoryManager< FilterMaxMinFields >

friend class MemoryManager< FilterMaxMinFields >

friend

Definition at line 1 of file FilterMaxMinFields.h.

Member Data Documentation

◆ className

std::string Nektar::SolverUtils::FilterMaxMinFields::className

static

Initial value:

=
    GetFilterFactory().RegisterCreatorFunction("MaxMinFields",
                                               FilterMaxMinFields::create)

Name of the class.

Definition at line 68 of file FilterMaxMinFields.h.

◆ m_curFieldsPhys

std::vector<Array<OneD, NekDouble> > Nektar::SolverUtils::FilterMaxMinFields::m_curFieldsPhys

protected

Definition at line 79 of file FilterMaxMinFields.h.

Referenced by v_Initialise(), and v_ProcessSample().

◆ m_initialized

bool Nektar::SolverUtils::FilterMaxMinFields::m_initialized

private

Definition at line 112 of file FilterMaxMinFields.h.

Referenced by FilterMaxMinFields(), v_Initialise(), and v_ProcessSample().

◆ m_isMax

bool Nektar::SolverUtils::FilterMaxMinFields::m_isMax

protected

Definition at line 77 of file FilterMaxMinFields.h.

Referenced by FilterMaxMinFields(), v_GetFileSuffix(), and v_ProcessSample().

◆ m_outFieldsPhys

std::vector<Array<OneD, NekDouble> > Nektar::SolverUtils::FilterMaxMinFields::m_outFieldsPhys

protected

Definition at line 80 of file FilterMaxMinFields.h.

Referenced by v_Initialise(), and v_ProcessSample().

◆ m_problemType

ProblemType Nektar::SolverUtils::FilterMaxMinFields::m_problemType

protected

Definition at line 78 of file FilterMaxMinFields.h.

Referenced by FilterMaxMinFields(), and v_Initialise().

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FilterMaxMinFields()

◆ ~FilterMaxMinFields()

Member Function Documentation

◆ create()

◆ v_FillVariablesName()

◆ v_GetFileSuffix()

◆ v_GetScale()

◆ v_Initialise()

◆ v_PrepareOutput()

◆ v_ProcessSample()

Friends And Related Function Documentation

◆ MemoryManager< FilterMaxMinFields >

Member Data Documentation

◆ className

◆ m_curFieldsPhys

◆ m_initialized

◆ m_isMax

◆ m_outFieldsPhys

◆ m_problemType