GIDI::Functions::WeightedFunctionals2d Class Reference

#include <GIDI.hpp>

Inheritance diagram for GIDI::Functions::WeightedFunctionals2d:

Public Member Functions
	WeightedFunctionals2d (Construction::Settings const &a_construction, HAPI::Node const &a_node, SetupInfo &a_setupInfo, Suite *a_parent)
	~WeightedFunctionals2d ()
double	domainMin () const
double	domainMax () const
std::vector< Weighted_function2d * > const &	weighted_function2d () const
double	evaluate (double a_x2, double a_x1) 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
virtual void	toXMLList_func (GUPI::WriteInfo &a_writeInfo, std::string const &a_indent, bool a_embedded, bool a_inRegions) 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 <weightedFunctionals> node.

Definition at line 1819 of file GIDI.hpp.

Constructor & Destructor Documentation

WeightedFunctionals2d()

GIDI::Functions::WeightedFunctionals2d::WeightedFunctionals2d	(	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 WeightedFunctionals2d instance.
a_setupInfo	[in] Information create my the Protare constructor to help in parsing.
a_parent	[in] The parent GIDI::Suite.

Definition at line 525 of file GIDI_energyFunctions2d.cc.

                                  :
        Function2dForm( a_construction, a_node, a_setupInfo, FormType::weightedFunctionals2d, a_parent ) {
 
    for( HAPI::Node child = a_node.first_child( ); !child.empty( ); child.to_next_sibling( ) ) {
        std::string name( child.name( ) );
 
        if( name != GIDI_weightedChars ) throw Exception( "WeightedFunctionals2d::WeightedFunctionals2d: bad child." );
        m_weighted_function2d.push_back( new Weighted_function2d( a_construction, child, a_setupInfo, nullptr ) );
    }
 
}

~WeightedFunctionals2d()

GIDI::Functions::WeightedFunctionals2d::~WeightedFunctionals2d

(

)

Definition at line 541 of file GIDI_energyFunctions2d.cc.

                                               {
 
    for( std::vector<Weighted_function2d *>::iterator iter = m_weighted_function2d.begin( ); iter < m_weighted_function2d.end( ); ++iter ) delete *iter;
}

Member Function Documentation

domainMax()

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

virtual

Returns the domain maximum for the instance.

Returns

The domain maximum for the instance.

Implements GIDI::Functions::FunctionForm.

Definition at line 570 of file GIDI_energyFunctions2d.cc.

                                               {
 
    double domainMax1 = m_weighted_function2d[0]->domainMax( );
 
    for( std::vector<Weighted_function2d *>::const_iterator iter = m_weighted_function2d.begin( ); iter < m_weighted_function2d.end( ); ++iter ) {
        double domainMax2 = (*iter)->domainMax( );
 
        if( domainMax2 < domainMax1 ) domainMax1 = domainMax2;
    }
    return( domainMax1 );
}

domainMin()

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

virtual

Returns the domain minimum for the instance.

Returns

The domain minimum for the instance.

Implements GIDI::Functions::FunctionForm.

Definition at line 552 of file GIDI_energyFunctions2d.cc.

                                               {
 
    double domainMin1 = m_weighted_function2d[0]->domainMin( );
 
    for( std::vector<Weighted_function2d *>::const_iterator iter = m_weighted_function2d.begin( ); iter < m_weighted_function2d.end( ); ++iter ) {
        double domainMin2 = (*iter)->domainMin( );
 
        if( domainMin2 < domainMin1 ) domainMin1 = domainMin2;
    }
    return( domainMin1 );
}

evaluate()

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

virtual

Implements GIDI::Functions::Function2dForm.

weighted_function2d()

std::vector< Weighted_function2d * > const & GIDI::Functions::WeightedFunctionals2d::weighted_function2d ( ) const

inline

Returns the value of the m_weighted_function2d member.

Definition at line 1831 of file GIDI.hpp.

Referenced by MCGIDI::Probabilities::WeightedFunctionals2d::WeightedFunctionals2d().

---

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

• GIDI.hpp
• GIDI_energyFunctions2d.cc