Nektar::LibUtilities::Equation Class Reference

#include <Equation.h>

Public Member Functions
	Equation (const Equation &)=default
	Equation (InterpreterSharedPtr evaluator, const std::string &expr="", const std::string &vlist="")
Equation &	operator= (const Equation &src)
NekDouble	Evaluate () const
NekDouble	Evaluate (NekDouble x, NekDouble y=0, NekDouble z=0, NekDouble t=0) const
void	Evaluate (const Array< OneD, const NekDouble > &x, const Array< OneD, const NekDouble > &y, const Array< OneD, const NekDouble > &z, Array< OneD, NekDouble > &result) const
void	Evaluate (const Array< OneD, const NekDouble > &x, const Array< OneD, const NekDouble > &y, const Array< OneD, const NekDouble > &z, const NekDouble t, Array< OneD, NekDouble > &result) const
void	Evaluate (const Array< OneD, const NekDouble > &x, const Array< OneD, const NekDouble > &y, const Array< OneD, const NekDouble > &z, const Array< OneD, const NekDouble > &t, Array< OneD, NekDouble > &result) const
void	Evaluate (const std::vector< Array< OneD, const NekDouble > > points, Array< OneD, NekDouble > &result) const
void	SetParameter (const std::string &name, NekDouble value)
void	SetConstants (const std::map< std::string, NekDouble > &constants)
std::string	GetExpression (void) const
std::string	GetVlist (void) const
NekDouble	GetTime () const
	Returns time spend on expression evaluation at points (it does not include parse/pre-processing time). More...

Private Attributes
std::string	m_vlist
std::string	m_expr
int	m_expr_id
InterpreterSharedPtr	m_evaluator

Detailed Description

This class stores a string form of a symbolic expression to be evaluated e.g. for the boundary conditions, the unique numeric ID of that expression and a reference to the unique static instance of the Interpreter.

The scenario is that for multiple copies of Equation class holding their symbolic expressions in the std::string form, there is a unique instance of Interpreter, which holds a set of pre-processed symbolic expressions in the form of sequential containers of execution functors, ready for fast evaluation.

The interpreter also keeps all constants and parameters specified in an XML file. There should be only one copy of Equation class per each symbolic expression specified in XML file, modulo possible bugs. Classes Equation and Interpreter are complementary in a sense that the expression ID stored in the Equation class is generated by the Interpreter which holds ordered container of pre-processed expressions.

Definition at line 72 of file Equation.h.

Constructor & Destructor Documentation

Equation() [1/2]

Nektar::LibUtilities::Equation::Equation ( const Equation &  )

default

Equation() [2/2]

Nektar::LibUtilities::Equation::Equation	(	InterpreterSharedPtr	evaluator,
		const std::string &	expr = "",
		const std::string &	vlist = ""
	)

Definition at line 45 of file Equation.cpp.

References Nektar::ErrorUtil::efatal, m_evaluator, m_expr, m_expr_id, m_vlist, CellMLToNektar.pycml::msg, and NEKERROR.

                                          :
    m_vlist     (vlist),
    m_expr      (expr),
    m_expr_id   (-1),
    m_evaluator (evaluator)
{
    boost::algorithm::trim(m_expr);
    boost::algorithm::trim(m_vlist);

    if (m_vlist.empty())
    {
        m_vlist = "x y z t";
    }

    try
    {
        if (!m_expr.empty())
        {
            m_expr_id = m_evaluator->DefineFunction(m_vlist, m_expr);
        }
    }
    catch (const std::runtime_error& e)
    {
        m_expr_id = -1;
        std::string msg(std::string("Equation::Equation() fails on expression [") + m_expr + std::string("]\n"));
        NEKERROR(ErrorUtil::efatal, msg);
        throw e;
        return;
    }
    catch (const std::string& e)
    {
        m_expr_id = -1;
        std::string msg(std::string("Equation::Equation() fails on expression [") + m_expr + std::string("]\n"));
        NEKERROR(ErrorUtil::efatal, msg);
        throw e;
        return;
    }
}

Member Function Documentation

Evaluate() [1/6]

NekDouble Nektar::LibUtilities::Equation::Evaluate

(

)

const

Definition at line 95 of file Equation.cpp.

References Nektar::ErrorUtil::efatal, m_evaluator, m_expr, m_expr_id, CellMLToNektar.pycml::msg, and NEKERROR.

Referenced by Evaluate(), Nektar::SolverUtils::FilterMovingAverage::FilterMovingAverage(), Nektar::SolverUtils::FilterReynoldsStresses::FilterReynoldsStresses(), Nektar::Extrapolate::GenerateHOPBCMap(), Nektar::SpatialDomains::MeshGraph::ReadExpansions(), Nektar::LibUtilities::SessionReader::ReadParameters(), Nektar::MultiRegions::DisContField3D::v_EvaluateBoundaryConditions(), Nektar::MultiRegions::DisContField3DHomogeneous1D::v_EvaluateBoundaryConditions(), Nektar::MultiRegions::DisContField2D::v_EvaluateBoundaryConditions(), Nektar::MultiRegions::DisContField3D::v_GetRobinBCInfo(), Nektar::MultiRegions::DisContField2D::v_GetRobinBCInfo(), Nektar::IncNavierStokes::v_InitObject(), Nektar::GlobalMapping::Mapping::v_UpdateBCs(), and Nektar::AcousticSystem::v_WhiteNoiseBC().

{
    try
    {
        if (m_expr_id != -1)
        {
            return m_evaluator->Evaluate(m_expr_id);
        }
    }
    catch (const std::runtime_error& e)
    {
        std::string msg(std::string("Equation::Evaluate fails on expression [") + m_expr + std::string("]\n"));
        NEKERROR(ErrorUtil::efatal, msg + std::string("ERROR: ") + e.what());
    }
    catch (const std::string& e)
    {
        std::string msg(std::string("Equation::Evaluate fails on expression [") + m_expr + std::string("]\n"));
        NEKERROR(ErrorUtil::efatal, msg + std::string("ERROR: ") + e);
    }
    return 0;
}

Evaluate() [2/6]

NekDouble Nektar::LibUtilities::Equation::Evaluate	(	NekDouble	x,
		NekDouble	y = 0,
		NekDouble	z = 0,
		NekDouble	t = 0
	)		const

Definition at line 117 of file Equation.cpp.

References Nektar::ErrorUtil::efatal, m_evaluator, m_expr, m_expr_id, CellMLToNektar.pycml::msg, and NEKERROR.

{
    try
    {
        if (m_expr_id != -1)
        {
            return m_evaluator->Evaluate(m_expr_id, x,y,z,t);
        }
    }
    catch (const std::runtime_error& e)
    {
        std::string msg =
            "Equation::Evaluate fails on expression [" + m_expr + "]\n";
        NEKERROR(ErrorUtil::efatal, msg + std::string("ERROR: ") + e.what());
    }
    catch (const std::string& e)
    {
        std::string msg =
            "Equation::Evaluate fails on expression [" + m_expr + "]\n";
        NEKERROR(ErrorUtil::efatal, msg + std::string("ERROR: ") + e);
    }

    return 0;
}

Evaluate() [3/6]

void Nektar::LibUtilities::Equation::Evaluate	(	const Array< OneD, const NekDouble > &	x,
		const Array< OneD, const NekDouble > &	y,
		const Array< OneD, const NekDouble > &	z,
		Array< OneD, NekDouble > &	result
	)		const

Definition at line 143 of file Equation.cpp.

References Evaluate().

{
    Array<OneD, NekDouble>  zero(x.num_elements(), 0.0);
    Evaluate(x,y,z,zero, result);
}

Evaluate() [4/6]

void Nektar::LibUtilities::Equation::Evaluate	(	const Array< OneD, const NekDouble > &	x,
		const Array< OneD, const NekDouble > &	y,
		const Array< OneD, const NekDouble > &	z,
		const NekDouble	t,
		Array< OneD, NekDouble > &	result
	)		const

Definition at line 153 of file Equation.cpp.

References Evaluate().

{
    Array<OneD, NekDouble>  time(x.num_elements(), t);
    Evaluate(x,y,z,time, result);
}

Evaluate() [5/6]

void Nektar::LibUtilities::Equation::Evaluate	(	const Array< OneD, const NekDouble > &	x,
		const Array< OneD, const NekDouble > &	y,
		const Array< OneD, const NekDouble > &	z,
		const Array< OneD, const NekDouble > &	t,
		Array< OneD, NekDouble > &	result
	)		const

Definition at line 165 of file Equation.cpp.

References Evaluate().

{
    std::vector<Array<OneD, const NekDouble> > points;
    points.push_back(x);
    points.push_back(y);
    points.push_back(z);
    points.push_back(t);
    Evaluate(points, result);
}

Evaluate() [6/6]

void Nektar::LibUtilities::Equation::Evaluate	(	const std::vector< Array< OneD, const NekDouble > >	points,
		Array< OneD, NekDouble > &	result
	)		const

Definition at line 180 of file Equation.cpp.

References Nektar::ErrorUtil::efatal, m_evaluator, m_expr, m_expr_id, CellMLToNektar.pycml::msg, and NEKERROR.

{
    try
    {
        if (m_expr_id != -1)
        {
            m_evaluator->Evaluate(m_expr_id, points, result);
        }
    }
    catch (const std::runtime_error& e)
    {
        std::string msg =
            "Equation::Evaluate fails on expression [" + m_expr + "]\n";
        NEKERROR(ErrorUtil::efatal, msg + std::string("ERROR: ") + e.what());
        return;
    }
    catch (const std::string& e)
    {
        std::string msg =
            "Equation::Evaluate fails on expression [" + m_expr + "]\n";
        NEKERROR(ErrorUtil::efatal, msg + std::string("ERROR: ") + e);
        return;
    }
}

GetExpression()

std::string Nektar::LibUtilities::Equation::GetExpression

(

void

)

const

Definition at line 217 of file Equation.cpp.

References m_expr.

Referenced by Nektar::Extrapolate::GenerateHOPBCMap().

{
    return m_expr;
}

GetTime()

NekDouble Nektar::LibUtilities::Equation::GetTime

(

)

const

Returns time spend on expression evaluation at points (it does not include parse/pre-processing time).

Definition at line 229 of file Equation.cpp.

References m_evaluator.

{
    return m_evaluator->GetTime();
}

GetVlist()

std::string Nektar::LibUtilities::Equation::GetVlist

(

void

)

const

Definition at line 222 of file Equation.cpp.

References m_vlist.

{
    return m_vlist;
}

operator=()

Equation & Nektar::LibUtilities::Equation::operator=

(

const Equation &

src

)

Definition at line 86 of file Equation.cpp.

References m_evaluator, m_expr, m_expr_id, and m_vlist.

{
    m_vlist     = src.m_vlist;
    m_expr      = src.m_expr;
    m_expr_id   = src.m_expr_id;
    m_evaluator = src.m_evaluator;
    return *this;
}

SetConstants()

void Nektar::LibUtilities::Equation::SetConstants

(

const std::map< std::string, NekDouble > &

constants

)

Definition at line 212 of file Equation.cpp.

References m_evaluator.

{
    m_evaluator->AddConstants(constants);
}

SetParameter()

void Nektar::LibUtilities::Equation::SetParameter	(	const std::string &	name,
		NekDouble	value
	)

Definition at line 207 of file Equation.cpp.

References m_evaluator.

{
    m_evaluator->SetParameter(name, value);
}

Member Data Documentation

m_evaluator

InterpreterSharedPtr Nektar::LibUtilities::Equation::m_evaluator

private

Definition at line 128 of file Equation.h.

Referenced by Equation(), Evaluate(), GetTime(), operator=(), SetConstants(), and SetParameter().

m_expr

std::string Nektar::LibUtilities::Equation::m_expr

private

Definition at line 126 of file Equation.h.

Referenced by Equation(), Evaluate(), GetExpression(), and operator=().

m_expr_id

int Nektar::LibUtilities::Equation::m_expr_id

private

Definition at line 127 of file Equation.h.

Referenced by Equation(), Evaluate(), and operator=().

m_vlist

std::string Nektar::LibUtilities::Equation::m_vlist

private

Definition at line 125 of file Equation.h.

Referenced by Equation(), GetVlist(), and operator=().