gridfire::MultiscalePartitioningEngineView::QSEGroup Struct Reference

Struct representing a QSE group. More...

Collaboration diagram for gridfire::MultiscalePartitioningEngineView::QSEGroup:

Public Member Functions
void	removeSpecies (const fourdst::atomic::Species &species)
void	addSpeciesToAlgebraic (const fourdst::atomic::Species &species)
void	addSpeciesToSeed (const fourdst::atomic::Species &species)
bool	operator< (const QSEGroup &other) const
	Less-than operator for QSEGroup, used for sorting.
bool	operator> (const QSEGroup &other) const
	Greater-than operator for QSEGroup.
bool	operator== (const QSEGroup &other) const
	Equality operator for QSEGroup.
bool	operator!= (const QSEGroup &other) const
	Inequality operator for QSEGroup.
std::string	toString () const

Public Attributes
bool	is_in_equilibrium = false
	Flag set by flux analysis.
std::set< fourdst::atomic::Species >	algebraic_species
	Algebraic species in this group.
std::set< fourdst::atomic::Species >	seed_species
	Dynamic species in this group.
double	mean_timescale
	Mean timescale of the group.

Detailed Description

Struct representing a QSE group.

Purpose

A container to hold all information about a set of species that are potentially in quasi-steady-state equilibrium with each other.

Member Function Documentation

addSpeciesToAlgebraic()

void gridfire::MultiscalePartitioningEngineView::QSEGroup::addSpeciesToAlgebraic

(

const fourdst::atomic::Species &

species

)

addSpeciesToSeed()

void gridfire::MultiscalePartitioningEngineView::QSEGroup::addSpeciesToSeed

(

const fourdst::atomic::Species &

species

)

operator!=()

bool gridfire::MultiscalePartitioningEngineView::QSEGroup::operator!=

(

const QSEGroup &

other

)

const

Inequality operator for QSEGroup.

Parameters

other

The other QSEGroup to compare to.

Returns

True if the sets of species indices are not identical.

operator<()

bool gridfire::MultiscalePartitioningEngineView::QSEGroup::operator<

(

const QSEGroup &

other

)

const

Less-than operator for QSEGroup, used for sorting.

Parameters

other

The other QSEGroup to compare to.

Returns

True if this group's mean timescale is less than the other's.

operator==()

bool gridfire::MultiscalePartitioningEngineView::QSEGroup::operator==

(

const QSEGroup &

other

)

const

Equality operator for QSEGroup.

Parameters

other

The other QSEGroup to compare to.

Returns

True if the sets of species indices are identical.

operator>()

bool gridfire::MultiscalePartitioningEngineView::QSEGroup::operator>

(

const QSEGroup &

other

)

const

Greater-than operator for QSEGroup.

Parameters

other

The other QSEGroup to compare to.

Returns

True if this group's mean timescale is greater than the other's.

removeSpecies()

void gridfire::MultiscalePartitioningEngineView::QSEGroup::removeSpecies

(

const fourdst::atomic::Species &

species

)

toString()

std::string gridfire::MultiscalePartitioningEngineView::QSEGroup::toString ( ) const

nodiscard

Member Data Documentation

algebraic_species

std::set<fourdst::atomic::Species> gridfire::MultiscalePartitioningEngineView::QSEGroup::algebraic_species

Algebraic species in this group.

is_in_equilibrium

bool gridfire::MultiscalePartitioningEngineView::QSEGroup::is_in_equilibrium = false

Flag set by flux analysis.

mean_timescale

double gridfire::MultiscalePartitioningEngineView::QSEGroup::mean_timescale

Mean timescale of the group.

seed_species

std::set<fourdst::atomic::Species> gridfire::MultiscalePartitioningEngineView::QSEGroup::seed_species

Dynamic species in this group.

---

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

• src/include/gridfire/engine/views/engine_multiscale.h
• src/lib/engine/views/engine_multiscale.cpp