#include <GIDI.hpp>

Inheritance diagram for GIDI::Styles::HeatedMultiGroup:

Public Member Functions
	HeatedMultiGroup (Construction::Settings const &a_construction, HAPI::Node const &a_node, SetupInfo &a_setupInfo, PoPI::Database const &a_pops, GIDI::Suite *a_parent)
	~HeatedMultiGroup ()
PhysicalQuantity const &	temperature () const
GIDI::Suite const &	transportables () const
Transportable const &	transportable (std::string const &a_ID) const
std::vector< double >	groupBoundaries (std::string const &a_ID) const
Flux const &	flux () const
std::string const &	parameters () const
Vector	inverseSpeedData () const
void	toXMLList (GUPI::WriteInfo &a_writeInfo, std::string const &a_indent) const
Public Member Functions inherited from GIDI::Styles::Base
	Base (HAPI::Node const &a_node, SetupInfo &a_setupInfo, GIDI::Suite *a_parent)
	~Base ()
std::string const &	date () const
std::string const &	label () const
std::string const &	derivedStyle () const
bool	hasDocumentation ()
GUPI::Documentation *	documentation ()
Base const *	getDerivedStyle () const
Base const *	getDerivedStyle (std::string const &a_moniker) const
std::vector< Base const * >	chain () const
bool	isStyleInDerivedForm (Base const *a_style) const
std::string	baseXMLAttributes (GUPI::WriteInfo &a_writeInfo) 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

This is the neatedMultiGroup style class.

Definition at line 3309 of file GIDI.hpp.

Constructor & Destructor Documentation

◆ HeatedMultiGroup()

GIDI::Styles::HeatedMultiGroup::HeatedMultiGroup	(	Construction::Settings const &	a_construction,
		HAPI::Node const &	a_node,
		SetupInfo &	a_setupInfo,
		PoPI::Database const &	a_pops,
		GIDI::Suite *	a_parent )

Parameters

a_construction	[in] Used to pass user options to the constructor.
a_node	[in] The HAPI::Node to be parsed.
a_setupInfo	[in] Information create my the Protare constructor to help in parsing.
a_pops	[in] A PoPI::Database instance used to get particle indices and possibly other particle information.
a_parent	[in] The parent GIDI::Suite.

Definition at line 740 of file GIDI_styles.cc.

                                                                  : 
        Base( a_node, a_setupInfo, a_parent ),
        m_transportables( a_construction, GIDI_transportablesChars, GIDI_labelChars, a_node, a_setupInfo, a_pops, a_pops, parseTransportablesSuite, nullptr ),
        m_flux( a_construction, a_node.child( GIDI_fluxNodeChars ), a_setupInfo ),
        m_inverseSpeed( a_construction, a_node.child( GIDI_inverseSpeedChars ).child( GIDI_gridded1dChars ), a_setupInfo, nullptr ),
        m_parameters( a_node.attribute_as_string( GIDI_parametersChars ) ) {
 
    m_transportables.setAncestor( this );
    m_flux.setAncestor( this );
    m_inverseSpeed.setAncestor( this );
 
    if( m_transportables.size( ) == 0 ) {
        GIDI::Suite const *transportables1 = nullptr;
        if( a_setupInfo.m_multiGroup != nullptr ) {
            transportables1 = &a_setupInfo.m_multiGroup->transportables( ); }
        else if( a_setupInfo.m_heatedMultiGroup != nullptr ) {
            transportables1 = &a_setupInfo.m_heatedMultiGroup->transportables( );
        }
        if( transportables1 != nullptr ) {
            for( std::size_t index = 0; index < transportables1->size( ); ++index ) {
                Transportable const &transportable = *transportables1->get<Transportable>( index );
 
                m_transportables.add( new Transportable( transportable ) );
            }
            
        } }
    else if( a_setupInfo.m_heatedMultiGroup == nullptr ) {
        a_setupInfo.m_heatedMultiGroup = this;
    }
}

◆ ~HeatedMultiGroup()

GIDI::Styles::HeatedMultiGroup::~HeatedMultiGroup ( )

Definition at line 775 of file GIDI_styles.cc.

                                     {
 
}

Referenced by ~HeatedMultiGroup().

Member Function Documentation

◆ flux()

Flux const & GIDI::Styles::HeatedMultiGroup::flux ( ) const

inline

Returns a const reference to member m_flux.

Definition at line 3326 of file GIDI.hpp.

◆ groupBoundaries()

std::vector< double > GIDI::Styles::HeatedMultiGroup::groupBoundaries ( std::string const & a_ID ) const

Returns the multi-group boundaries for the particle with id a_ID used for processing this HeatedMultiGroup.

Parameters

a_ID	[in] Particle id for the requested product.

Returns: The multi-group boundaries.

Definition at line 813 of file GIDI_styles.cc.

                                                                                 {
 
    Transportable const &transportable1 = transportable( a_ID );
 
    return( transportable1.groupBoundaries( ) );
}

Referenced by GIDI::ProtareSingle::groupBoundaries(), groupBoundaries(), and GIDI::Reaction::recalculateMultiGroupData().

◆ inverseSpeedData()

Vector GIDI::Styles::HeatedMultiGroup::inverseSpeedData ( ) const

inline

Returns the value of the m_inverseSpeed data.

Definition at line 3329 of file GIDI.hpp.

Referenced by GIDI::ProtareSingle::multiGroupInverseSpeed().

◆ parameters()

std::string const & GIDI::Styles::HeatedMultiGroup::parameters ( ) const

inline

Returns a const reference to member m_parameters. Only used for GNDS 1.10.

Definition at line 3327 of file GIDI.hpp.

◆ temperature()

PhysicalQuantity const & GIDI::Styles::HeatedMultiGroup::temperature ( ) const

virtual

Ascends the derivedFrom styles until a temperature is found.

Returns: Returns the temperature associated with this style.

Implements GIDI::Styles::Base.

Definition at line 785 of file GIDI_styles.cc.

                                                             {
 
    Base const *style = getDerivedStyle( );
 
    if( style == nullptr ) throw Exception( "No style with temperature." );
    return( style->temperature( ) );
}

Referenced by temperature().

◆ toXMLList()

void GIDI::Styles::HeatedMultiGroup::toXMLList	(	GUPI::WriteInfo &	a_writeInfo,
		std::string const &	a_indent ) 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.

Reimplemented from GUPI::Ancestry.

Definition at line 827 of file GIDI_styles.cc.

                                                                                              {
    
    std::string indent2 = a_writeInfo.incrementalIndent( a_indent );
    std::string indent3 = a_writeInfo.incrementalIndent( indent2 );
    std::string attributes = baseXMLAttributes( a_writeInfo );
    
    attributes += a_writeInfo.addAttribute( GIDI_parametersChars, m_parameters );
    a_writeInfo.addNodeStarter( a_indent, moniker( ), attributes );
    m_flux.toXMLList( a_writeInfo, indent2 );
 
    a_writeInfo.addNodeStarter( indent2, GIDI_inverseSpeedChars, "" );
    m_inverseSpeed.toXMLList_func( a_writeInfo, indent3, false, false );
    a_writeInfo.addNodeEnder( GIDI_inverseSpeedChars );
    a_writeInfo.addNodeEnder( moniker( ) );
}

Referenced by toXMLList().

◆ transportable()

Transportable const & GIDI::Styles::HeatedMultiGroup::transportable ( std::string const & a_ID ) const

Returns the Transportable instance for the particle with id a_ID used for processing this HeatedMultiGroup.

Parameters

a_ID	[in] Particle id for the requested product.

Returns: The multi-group boundaries.

Definition at line 800 of file GIDI_styles.cc.

                                                                                  {
 
    return( *m_transportables.get<Transportable>( a_ID ) );
}

Referenced by groupBoundaries(), GIDI::Transporting::Particles::process(), and transportable().

◆ transportables()

GIDI::Suite const & GIDI::Styles::HeatedMultiGroup::transportables ( ) const

inline

Returns a const reference to m_transportables.

Definition at line 3323 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

◆ HeatedMultiGroup()

◆ ~HeatedMultiGroup()

Member Function Documentation

◆ flux()

◆ groupBoundaries()

◆ inverseSpeedData()

◆ parameters()

◆ temperature()

◆ toXMLList()

◆ transportable()

◆ transportables()