Nektar::SolverUtils::FilterError Class Reference

#include <FilterError.h>

Inheritance diagram for Nektar::SolverUtils::FilterError:

Public Member Functions
SOLVER_UTILS_EXPORT	FilterError (const LibUtilities::SessionReaderSharedPtr &pSession, const std::weak_ptr< EquationSystem > &pEquation, const ParamMap &pParams)
SOLVER_UTILS_EXPORT	~FilterError () override=default
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) final
void	v_Update (const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time) final
void	v_Finalise (const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time) final
bool	v_IsTimeDependent () final
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
size_t	m_index = 0
size_t	m_outputFrequency
size_t	m_numVariables
bool	m_homogeneous
std::ofstream	m_outFile
LibUtilities::CommSharedPtr	m_comm

Friends
class	MemoryManager< FilterError >

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 42 of file FilterError.h.

Constructor & Destructor Documentation

FilterError()

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

Definition at line 42 of file FilterError.cpp.

    : Filter(pSession, pEquation)
{
    std::string outName;
 
    // OutputFile
    auto it = pParams.find("OutputFile");
    if (it == pParams.end())
    {
        outName = m_session->GetSessionName();
    }
    else
    {
        ASSERTL0(it->second.length() > 0, "Empty parameter 'OutputFile'.");
        outName = it->second;
    }
    outName += ".err";
 
    // Lock equation system pointer
    auto equationSys = m_equ.lock();
    ASSERTL0(equationSys, "Weak pointer expired");
 
    m_numVariables = equationSys->GetNvariables();
 
    m_comm = pSession->GetComm();
    if (m_comm->GetRank() == 0)
    {
        m_outFile.open(outName);
        ASSERTL0(m_outFile.good(), "Unable to open: '" + outName + "'");
        m_outFile.setf(std::ios::scientific, std::ios::floatfield);
 
        m_outFile << "Time";
        for (size_t i = 0; i < m_numVariables; ++i)
        {
            std::string varName = equationSys->GetVariable(i);
            m_outFile << " " + varName + "_L2"
                      << " " + varName + "_Linf";
        }
 
        m_outFile << std::endl;
    }
 
    // OutputFrequency
    it = pParams.find("OutputFrequency");
    if (it == pParams.end())
    {
        m_outputFrequency = 1;
    }
    else
    {
        ASSERTL0(it->second.length() > 0, "Empty parameter 'OutputFrequency'.");
        LibUtilities::Equation equ(m_session->GetInterpreter(), it->second);
        m_outputFrequency = round(equ.Evaluate());
    }
}

References ASSERTL0, Nektar::LibUtilities::Equation::Evaluate(), m_comm, Nektar::SolverUtils::Filter::m_equ, m_numVariables, m_outFile, m_outputFrequency, and Nektar::SolverUtils::Filter::m_session.

~FilterError()

SOLVER_UTILS_EXPORT Nektar::SolverUtils::FilterError::~FilterError ( )

overridedefault

Member Function Documentation

create()

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

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

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

v_Finalise()

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

finalprotectedvirtual

Implements Nektar::SolverUtils::Filter.

Definition at line 161 of file FilterError.cpp.

{
    if (m_comm->GetRank() == 0)
    {
        m_outFile.close();
    }
}

References m_comm, and m_outFile.

v_Initialise()

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

finalprotectedvirtual

Implements Nektar::SolverUtils::Filter.

Definition at line 100 of file FilterError.cpp.

{
 
    // Check for homogeneous expansion
    m_homogeneous = pFields[0]->GetExpType() == MultiRegions::e3DH1D ||
                    pFields[0]->GetExpType() == MultiRegions::e3DH2D;
 
    v_Update(pFields, time);
}

References Nektar::MultiRegions::e3DH1D, Nektar::MultiRegions::e3DH2D, m_homogeneous, and v_Update().

v_IsTimeDependent()

bool Nektar::SolverUtils::FilterError::v_IsTimeDependent ( )

finalprotectedvirtual

Implements Nektar::SolverUtils::Filter.

Definition at line 172 of file FilterError.cpp.

{
    return true;
}

v_Update()

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

finalprotectedvirtual

Implements Nektar::SolverUtils::Filter.

Definition at line 112 of file FilterError.cpp.

{
    // Check whether output frequency matches
    if (m_index++ % m_outputFrequency > 0)
    {
        return;
    }
 
    // Output to file L2 and Linf error for each variable
    if (m_comm->GetRank() == 0)
    {
        m_outFile << time;
    }
 
    // Lock equation system pointer
    auto equationSys = m_equ.lock();
    ASSERTL0(equationSys, "Weak pointer expired");
 
    for (size_t i = 0; i < m_numVariables; ++i)
    {
        // Evaluate "ExactSolution" function, or zero array
        Array<OneD, NekDouble> exactsoln(pFields[i]->GetTotPoints(), 0.0);
        equationSys->EvaluateExactSolution(i, exactsoln, time);
 
        // If homogeneous expansion is used, transform the solution to
        // Fourier (Wave) space
        if (m_homogeneous)
        {
            pFields[i]->HomogeneousFwdTrans(pFields[i]->GetTotPoints(),
                                            exactsoln, exactsoln);
        }
 
        NekDouble vL2Error   = equationSys->L2Error(i, exactsoln);
        NekDouble vLinfError = equationSys->LinfError(i, exactsoln);
 
        if (m_comm->GetRank() == 0)
        {
            m_outFile << " " << vL2Error << " " << vLinfError;
        }
    }
 
    if (m_comm->GetRank() == 0)
    {
        m_outFile << std::endl;
    }
}

References ASSERTL0, m_comm, Nektar::SolverUtils::Filter::m_equ, m_homogeneous, m_index, m_numVariables, m_outFile, and m_outputFrequency.

Referenced by v_Initialise().

Friends And Related Function Documentation

MemoryManager< FilterError >

friend class MemoryManager< FilterError >

friend

Definition at line 1 of file FilterError.h.

Member Data Documentation

className

std::string Nektar::SolverUtils::FilterError::className

static

Initial value:

=
    GetFilterFactory().RegisterCreatorFunction("Error", FilterError::create)

Name of the class.

Definition at line 59 of file FilterError.h.

m_comm

LibUtilities::CommSharedPtr Nektar::SolverUtils::FilterError::m_comm

private

Definition at line 85 of file FilterError.h.

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

m_homogeneous

bool Nektar::SolverUtils::FilterError::m_homogeneous

private

Definition at line 83 of file FilterError.h.

Referenced by v_Initialise(), and v_Update().

m_index

size_t Nektar::SolverUtils::FilterError::m_index = 0

private

Definition at line 80 of file FilterError.h.

Referenced by v_Update().

m_numVariables

size_t Nektar::SolverUtils::FilterError::m_numVariables

private

Definition at line 82 of file FilterError.h.

Referenced by FilterError(), and v_Update().

m_outFile

std::ofstream Nektar::SolverUtils::FilterError::m_outFile

private

Definition at line 84 of file FilterError.h.

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

m_outputFrequency

size_t Nektar::SolverUtils::FilterError::m_outputFrequency

private

Definition at line 81 of file FilterError.h.

Referenced by FilterError(), and v_Update().