#include <GIDI.hpp>

Inheritance diagram for GIDI::Functions::GeneralEvaporation2d:

Public Member Functions
	GeneralEvaporation2d (Construction::Settings const &a_construction, HAPI::Node const &a_node, SetupInfo &a_setupInfo, Suite *a_parent)
	~GeneralEvaporation2d ()
double	U () const
Function1dForm const *	theta () const
Function1dForm const *	g () const
double	domainMin () const
double	domainMax () const
double	evaluate (double a_x2, double a_x1) const
void	toXMLList_func (GUPI::WriteInfo &a_writeInfo, std::string const &a_indent, bool a_embedded, bool a_inRegions) const
Public Member Functions inherited from GIDI::Functions::Function2dForm
	Function2dForm (std::string const &a_moniker, FormType a_type, ptwXY_interpolation a_interpolation, int a_index, double a_outerDomainValue)
	Function2dForm (std::string const &a_moniker, FormType a_type, Axes const &a_axes, ptwXY_interpolation a_interpolation, int a_index, double a_outerDomainValue)
	Function2dForm (Construction::Settings const &a_construction, HAPI::Node const &a_node, SetupInfo &a_setupInfo, FormType a_type, Suite *a_suite=nullptr)
	Function2dForm (Function2dForm const &a_form)
	~Function2dForm ()
Public Member Functions inherited from GIDI::Functions::FunctionForm
	FunctionForm (std::string const &a_moniker, FormType a_type, int a_dimension, ptwXY_interpolation a_interpolation, int a_index, double a_outerDomainValue)
	FunctionForm (std::string const &a_moniker, FormType a_type, int a_dimension, Axes const &a_axes, ptwXY_interpolation a_interpolation, int a_index, double a_outerDomainValue)
	FunctionForm (Construction::Settings const &a_construction, HAPI::Node const &a_node, SetupInfo &a_setupInfo, FormType a_type, int a_dimension, Suite *a_suite=nullptr)
	FunctionForm (FunctionForm const &a_form)
	~FunctionForm ()
FunctionForm &	operator= (FunctionForm const &a_rhs)
int	dimension () const
int	index () const
double	outerDomainValue () const
void	setOuterDomainValue (double a_outerDomainValue)
Axes const &	axes () const
Axes &	axes ()
ptwXY_interpolation	interpolation () const
void	setInterpolation (ptwXY_interpolation a_interpolation)
std::string	interpolationString () const
void	toXMLList (GUPI::WriteInfo &a_writeInfo, std::string const &a_indent) const
Public Member Functions inherited from GIDI::Form
	Form (FormType a_type)
	Form (std::string const &a_moniker, FormType a_type, std::string const &a_label)
	Form (HAPI::Node const &a_node, SetupInfo &a_setupInfo, FormType a_type, Suite *a_suite=nullptr)
	Form (Form const &a_form)
virtual	~Form ()
Form &	operator= (Form const &a_rhs)
Suite *	parent () const
std::string const &	label () const
void	setLabel (std::string const &a_label)
virtual std::string	actualMoniker () const
std::string const &	keyName () const
void	setKeyName (std::string const &a_keyName)
std::string const &	keyValue () const
virtual void	setKeyValue (std::string const &a_keyName) const
FormType	type () const
Form const *	sibling (std::string a_label) const
GUPI::Ancestry *	findInAncestry3 (LUPI_maybeUnused std::string const &a_item)
GUPI::Ancestry const *	findInAncestry3 (LUPI_maybeUnused std::string const &a_item) const
std::string	xlinkItemKey () const
Public Member Functions inherited from GUPI::Ancestry
	Ancestry (std::string const &a_moniker, std::string const &a_attribute="")
virtual	~Ancestry ()
Ancestry &	operator= (Ancestry const &a_ancestry)
std::string const &	moniker () const
void	setMoniker (std::string const &a_moniker)
Ancestry *	ancestor ()
Ancestry const *	ancestor () const
void	setAncestor (Ancestry *a_ancestor)
std::string	attribute () const
Ancestry *	root ()
Ancestry const *	root () const
bool	isChild (Ancestry *a_instance)
bool	isParent (Ancestry *a_parent)
bool	isRoot () const
Ancestry *	findInAncestry (std::string const &a_href)
Ancestry const *	findInAncestry (std::string const &a_href) const
virtual Ancestry *	findInAncestry3 (std::string const &a_item)=0
virtual Ancestry const *	findInAncestry3 (std::string const &a_item) const =0
virtual LUPI_HOST void	serialize (LUPI::DataBuffer &a_buffer, LUPI::DataBuffer::Mode a_mode)
std::string	toXLink () const
void	printXML () const

Additional Inherited Members
Static Public Member Functions inherited from GUPI::Ancestry
static std::string	buildXLinkItemKey (std::string const &a_name, std::string const &a_key)

Detailed Description

Class for the GNDS <generalEvaporation> node.

Definition at line 1664 of file GIDI.hpp.

Constructor & Destructor Documentation

◆ GeneralEvaporation2d()

GIDI::Functions::GeneralEvaporation2d::GeneralEvaporation2d	(	Construction::Settings const &	a_construction,
		HAPI::Node const &	a_node,
		SetupInfo &	a_setupInfo,
		Suite *	a_parent )

Parameters

a_construction	[in] Used to pass user options for parsing.
a_node	[in] The HAPI::Node to be parsed to construct a GeneralEvaporation2d instance.
a_setupInfo	[in] Information create my the Protare constructor to help in parsing.
a_parent	[in] The parent GIDI::Suite.

Definition at line 29 of file GIDI_energyFunctions2d.cc.

                                                                                                                                                        :
        Function2dForm( a_construction, a_node, a_setupInfo, FormType::generalEvaporation2d, a_parent ),
        m_U( a_node.child( GIDI_UChars ), a_setupInfo ),
        m_theta( data1dParse( a_construction, a_node.child( GIDI_thetaChars ).first_child( ), a_setupInfo, nullptr ) ),
        m_g( data1dParse( a_construction, a_node.child( GIDI_gChars ).first_child( ), a_setupInfo, nullptr ) ) {
 
}

◆ ~GeneralEvaporation2d()

GIDI::Functions::GeneralEvaporation2d::~GeneralEvaporation2d ( )

Definition at line 40 of file GIDI_energyFunctions2d.cc.

                                             {
 
    delete m_theta;
    delete m_g;
}

Member Function Documentation

◆ domainMax()

double GIDI::Functions::GeneralEvaporation2d::domainMax ( ) const

virtual

Returns the domain maximum for the instance.

Returns: The domain maximum for the instance.

Implements GIDI::Functions::FunctionForm.

Definition at line 63 of file GIDI_energyFunctions2d.cc.

                                              {
 
    return( m_theta->domainMax( ) );
}

◆ domainMin()

double GIDI::Functions::GeneralEvaporation2d::domainMin ( ) const

virtual

Returns the domain minimum for the instance.

Returns: The domain minimum for the instance.

Implements GIDI::Functions::FunctionForm.

Definition at line 52 of file GIDI_energyFunctions2d.cc.

                                              {
 
    return( m_theta->domainMin( ) );
}

◆ evaluate()

double GIDI::Functions::GeneralEvaporation2d::evaluate	(	double	a_x2,
		double	a_x1 ) const

virtual

Implements GIDI::Functions::Function2dForm.

◆ g()

Function1dForm const * GIDI::Functions::GeneralEvaporation2d::g ( ) const

inline

Returns the value of the m_g member.

Definition at line 1677 of file GIDI.hpp.

◆ theta()

Function1dForm const * GIDI::Functions::GeneralEvaporation2d::theta ( ) const

inline

Returns the value of the m_theta member.

Definition at line 1676 of file GIDI.hpp.

◆ toXMLList_func()

void GIDI::Functions::GeneralEvaporation2d::toXMLList_func	(	GUPI::WriteInfo &	a_writeInfo,
		std::string const &	a_indent,
		bool	a_embedded,
		bool	a_inRegions ) const

virtual

Fills the argument a_writeInfo with the XML lines that represent this. Recursively enters each sub-node.

Parameters

a_writeInfo	[in/out] Instance containing incremental indentation and other information and stores the appended lines.
a_indent	[in] The amount to indent this node.
a_embedded	[in] If true, this function is embedded in a higher dimensional function.
a_inRegions	[in] This is not used in this method.

Reimplemented from GIDI::Functions::FunctionForm.

Definition at line 91 of file GIDI_energyFunctions2d.cc.

                                                                                                                                                                            {
 
    std::string indent2 = a_writeInfo.incrementalIndent( a_indent );
    std::string attributes;
 
    a_writeInfo.addNodeStarter( a_indent, moniker( ), attributes );
 
    m_U.toXMLList( a_writeInfo, indent2 );
    energy2dToXMLList( a_writeInfo, GIDI_thetaChars, indent2, m_theta );
    energy2dToXMLList( a_writeInfo, GIDI_gChars, indent2, m_g );
    a_writeInfo.addNodeEnder( moniker( ) );
}

Referenced by evaluate().

◆ U()

double GIDI::Functions::GeneralEvaporation2d::U ( ) const

inline

Returns the GNDS U value for this.

Definition at line 1675 of file GIDI.hpp.

The documentation for this class was generated from the following files:

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ GeneralEvaporation2d()

◆ ~GeneralEvaporation2d()

Member Function Documentation

◆ domainMax()

◆ domainMin()

◆ evaluate()

◆ g()

◆ theta()

◆ toXMLList_func()

◆ U()