GEOS
Classes | Public Member Functions | Static Public Member Functions | List of all members
geos::SourceFluxStatsAggregator Class Referencefinal

#include <SourceFluxStatistics.hpp>

Inheritance diagram for geos::SourceFluxStatsAggregator:
Inheritance graph
[legend]

Classes

struct  StatData
 Aggregated flux statistics data. More...
 
struct  viewKeyStruct
 View keys. More...
 
class  WrappedStats
 Class that aggregate statistics of a flux over multiple time-steps for a given SourceFluxStatsAggregator and a for a given mesh part (i.e. a subregion, a region...). More...
 

Public Member Functions

 SourceFluxStatsAggregator (const string &name, Group *const parent)
 Constructor for the statistics class. More...
 
virtual bool execute (real64 const time_n, real64 const dt, integer const cycleNumber, integer const eventCounter, real64 const eventProgress, DomainPartition &domain) override
 Main extension point of executable targets. More...
 
template<typename LAMBDA >
void forMeshLevelStatsWrapper (DomainPartition &domain, LAMBDA &&lambda)
 Apply a functor to WrappedStats that combines all stats for each target solver discretization mesh levels. More...
 
template<typename LAMBDA >
void forAllFluxStatsWrappers (MeshLevel &meshLevel, LAMBDA &&lambda)
 Apply a functor to each WrappedStats that combines the stats over all region for a flux. More...
 
template<typename LAMBDA >
void forAllRegionStatsWrappers (MeshLevel &meshLevel, string_view fluxName, LAMBDA &&lambda)
 Apply a functor to all simulated region WrappedStats (of the given MeshLevel) that target a given flux. More...
 
template<typename LAMBDA >
void forAllSubRegionStatsWrappers (ElementRegionBase &region, string_view fluxName, LAMBDA &&lambda)
 Apply a functor to all subregion WrappedStats (of the given region) that target a given flux. More...
 
string getStatWrapperName (string_view fluxName) const
 
- Public Member Functions inherited from geos::FieldStatisticsBase< FlowSolverBase >
 FieldStatisticsBase (const string &name, Group *const parent)
 Constructor for the statistics class. More...
 
- Public Member Functions inherited from geos::TaskBase
 TaskBase (string const &name, Group *const parent)
 Constructor. More...
 
- Public Member Functions inherited from geos::ExecutableGroup
virtual void signalToPrepareForExecution (real64 const time_n, real64 const dt, integer const cycle, DomainPartition &domain)
 Inform the object that it expects to execute during the next timestep. More...
 
virtual void cleanup (real64 const time_n, integer const cycleNumber, integer const eventCounter, real64 const eventProgress, DomainPartition &domain)
 Called as the code exits the main run loop. More...
 
virtual real64 getTimestepRequest (real64 const time)
 Supplies the timestep request for this target to the event manager. More...
 
void setTimesteppingBehavior (TimesteppingBehavior const timesteppingBehavior)
 Set the timestep behavior for a target. More...
 
TimesteppingBehavior getTimesteppingBehavior () const
 Get the target's time step behavior. More...
 
- Public Member Functions inherited from geos::dataRepository::Group
template<typename LOG_LEVEL_INFO >
std::enable_if_t< geos::is_log_level_info< LOG_LEVEL_INFO >, void > addLogLevel ()
 Append a levelCondition and a log description to the description of the wrapped object given a log info struct. Must be called in constructor. More...
 
virtual bool registerCallback (void *func, const std::type_info &funcType)
 Register a callback function on the group. More...
 
virtual void reinit ()
 Performs re-initialization of certain variable depending on the solver being used.
 
 Group (string const &name, Group *const parent)
 Constructor. More...
 
 Group (string const &name, conduit::Node &rootNode)
 Constructor. More...
 
 Group (Group &&source)=default
 Move constructor. More...
 
virtual ~Group ()
 Destructor, deletes all Groups and Wrappers owned by this Group.
 
 Group ()=delete
 Deleted default constructor.
 
 Group (Group const &)=delete
 Deleted copy constructor.
 
Groupoperator= (Group const &)=delete
 Deleted copy assignment operator. More...
 
Groupoperator= (Group &&)=delete
 Deleted move assignment operator. More...
 
void printDataHierarchy (integer indent=0) const
 Prints the data hierarchy recursively. More...
 
string dumpInputOptions () const
 
string dumpSubGroupsNames () const
 
string dumpWrappersNames () const
 
template<typename T = Group>
T & registerGroup (string const &name, std::unique_ptr< T > newObject)
 Register a new Group as a sub-group of current Group. More...
 
template<typename T = Group>
T & registerGroup (string const &name, T *newObject)
 Register a new Group as a sub-group of current Group. More...
 
template<typename T = Group>
T & registerGroup (string const &name)
 Register a new Group as a sub-group of current Group. More...
 
template<typename T = Group>
T & registerGroup (subGroupMap::KeyIndex const &keyIndex)
 Register a new Group as a sub-group of current Group. More...
 
template<typename T = Group, typename TBASE = Group>
T & registerGroup (string const &name, string const &catalogName)
 Register a new Group as a sub-group of current Group. More...
 
void deregisterGroup (string const &name)
 Removes a child group from this group. More...
 
virtual GroupcreateChild (string const &childKey, string const &childName)
 Creates a new sub-Group using the ObjectCatalog functionality. More...
 
template<typename T = Group, typename KEY = void>
T * getGroupPointer (KEY const &key)
 Return a pointer to a sub-group of the current Group. More...
 
template<typename T = Group, typename KEY = void>
T const * getGroupPointer (KEY const &key) const
 Return a pointer to a sub-group of the current Group. More...
 
template<typename T = Group, typename KEY = void>
T & getGroup (KEY const &key)
 Return a reference to a sub-group of the current Group. More...
 
template<typename T = Group, typename KEY = void>
T const & getGroup (KEY const &key) const
 Return a reference to a sub-group of the current Group. More...
 
template<typename T = Group>
T & getGroupByPath (string const &path)
 Retrieve a group from the hierarchy using a path. More...
 
template<typename T = Group>
T const & getGroupByPath (string const &path) const
 Retrieve a group from the hierarchy using a path. More...
 
subGroupMapgetSubGroups ()
 Get the subgroups object. More...
 
subGroupMap const & getSubGroups () const
 Get the subgroups object. More...
 
localIndex numSubGroups () const
 return the number of sub groups in this Group More...
 
std::vector< stringgetSubGroupsNames () const
 
template<typename T = Group>
bool hasGroup (string const &name) const
 Check whether a sub-group exists. More...
 
template<typename T >
bool hasSubGroupOfType () const
 Check whether a sub-group exists by type. More...
 
template<typename GROUPTYPE = Group, typename ... GROUPTYPES, typename LAMBDA >
void forSubGroups (LAMBDA &&lambda)
 Apply the given functor to subgroups that can be casted to one of specified types. More...
 
template<typename GROUPTYPE = Group, typename ... GROUPTYPES, typename LAMBDA >
void forSubGroups (LAMBDA &&lambda) const
 Apply the given functor to subgroups that can be casted to one of specified types. More...
 
template<typename GROUPTYPE = Group, typename ... GROUPTYPES, typename LAMBDA >
void forSubGroupsIndex (LAMBDA &&lambda)
 Apply the given functor to subgroups that can be casted to one of specified types. More...
 
template<typename GROUPTYPE = Group, typename ... GROUPTYPES, typename LAMBDA >
void forSubGroupsIndex (LAMBDA &&lambda) const
 Apply the given functor to subgroups that can be casted to one of specified types. More...
 
template<typename GROUPTYPE = Group, typename ... GROUPTYPES, typename LOOKUP_CONTAINER , typename LAMBDA >
void forSubGroups (LOOKUP_CONTAINER const &subGroupKeys, LAMBDA &&lambda)
 Apply the given functor to subgroups that can be casted to one of specified types. More...
 
template<typename GROUPTYPE = Group, typename ... GROUPTYPES, typename LOOKUP_CONTAINER , typename LAMBDA >
void forSubGroups (LOOKUP_CONTAINER const &subGroupKeys, LAMBDA &&lambda) const
 Apply the given functor to subgroups that can be casted to one of specified types. More...
 
template<typename LAMBDA >
void forWrappers (LAMBDA &&lambda)
 Apply the given functor to wrappers. More...
 
template<typename LAMBDA >
void forWrappers (LAMBDA &&lambda) const
 Apply the given functor to wrappers. More...
 
template<typename TYPE , typename ... TYPES, typename LAMBDA >
void forWrappers (LAMBDA &&lambda)
 Apply the given functor to wrappers that can be cast to one of specified types. More...
 
template<typename TYPE , typename ... TYPES, typename LAMBDA >
void forWrappers (LAMBDA &&lambda) const
 Apply the given functor to wrappers that can be cast to one of specified types. More...
 
virtual void initialize_postMeshGeneration ()
 initialization post generation of the mesh.
 
void initialize ()
 Run initialization functions on this and all subgroups. More...
 
virtual void initializationOrder (string_array &order)
 Sets the initialization order for sub-Groups. More...
 
void initializePostInitialConditions ()
 Initialization routine to be called after calling ApplyInitialConditions(). More...
 
void postRestartInitializationRecursive ()
 Initialization routine to be called after calling reading a restart file. More...
 
void processInputFileRecursive (xmlWrapper::xmlDocument &xmlDocument, xmlWrapper::xmlNode &targetNode)
 Recursively read values using ProcessInputFile() from the input file and put them into the wrapped values for this group. Also add the includes content to the xmlDocument when Include nodes are encountered. More...
 
void processInputFileRecursive (xmlWrapper::xmlDocument &xmlDocument, xmlWrapper::xmlNode &targetNode, xmlWrapper::xmlNodePos const &nodePos)
 Same as processInputFileRecursive(xmlWrapper::xmlDocument &, xmlWrapper::xmlNode &) but allow to reuse an existing xmlNodePos. More...
 
void postInputInitializationRecursive ()
 Recursively call postInputInitialization() to apply post processing after reading input values.
 
template<typename T , typename TBASE = T>
Wrapper< TBASE > & registerWrapper (string const &name, wrapperMap::KeyIndex::index_type *const rkey=nullptr)
 Create and register a Wrapper around a new object. More...
 
template<typename T , typename TBASE = T>
Wrapper< TBASE > & registerWrapper (Group::wrapperMap::KeyIndex const &viewKey)
 Create and register a Wrapper around a new object. More...
 
template<typename T >
Wrapper< T > & registerWrapper (string const &name, std::unique_ptr< T > newObject)
 Register a Wrapper around a given object and take ownership. More...
 
template<typename T >
Wrapper< T > & registerWrapper (string const &name, T *newObject)
 Register a Wrapper around an existing object, does not take ownership of the object. More...
 
WrapperBaseregisterWrapper (std::unique_ptr< WrapperBase > wrapper)
 Register and take ownership of an existing Wrapper. More...
 
void deregisterWrapper (string const &name)
 Removes a Wrapper from this group. More...
 
void generateDataStructureSkeleton (integer const level)
 Build a complete datastructure for schema generation. More...
 
virtual void expandObjectCatalogs ()
 Expand any catalogs in the data structure.
 
virtual void setSchemaDeviations (xmlWrapper::xmlNode schemaRoot, xmlWrapper::xmlNode schemaParent, integer documentationType)
 Inform the schema generator of any deviations between the xml and GEOS data structures. More...
 
virtual void registerDataOnMeshRecursive (Group &meshBodies)
 Calls RegisterDataOnMesh() recursively. More...
 
virtual localIndex packSize (string_array const &wrapperNames, integer const recursive, bool onDevice, parallelDeviceEvents &events) const
 Get the size required to pack a list of wrappers. More...
 
virtual localIndex packSize (string_array const &wrapperNames, arrayView1d< localIndex const > const &packList, integer const recursive, bool onDevice, parallelDeviceEvents &events) const
 Get the size required to pack a list of indices within a list of wrappers. More...
 
localIndex packSize (arrayView1d< localIndex const > const &packList, integer const recursive, bool onDevice, parallelDeviceEvents &events) const
 Get the size required to pack a list of indices for all registered wrappers. More...
 
virtual localIndex pack (buffer_unit_type *&buffer, string_array const &wrapperNames, integer const recursive, bool onDevice, parallelDeviceEvents &events) const
 Pack a list of wrappers to a buffer. More...
 
virtual localIndex pack (buffer_unit_type *&buffer, string_array const &wrapperNames, arrayView1d< localIndex const > const &packList, integer const recursive, bool onDevice, parallelDeviceEvents &events) const
 Pack a list of indices within a list of wrappers. More...
 
localIndex pack (buffer_unit_type *&buffer, arrayView1d< localIndex const > const &packList, integer const recursive, bool onDevice, parallelDeviceEvents &events) const
 Pack a list of indices for all registered wrappers. More...
 
virtual localIndex unpack (buffer_unit_type const *&buffer, arrayView1d< localIndex > &packList, integer const recursive, bool onDevice, parallelDeviceEvents &events, MPI_Op op=MPI_REPLACE)
 Unpack a buffer. More...
 
template<typename KEY >
WrapperBase const & getWrapperBase (KEY const &key) const
 Return a reference to a WrapperBase stored in this group. More...
 
template<typename KEY >
WrapperBasegetWrapperBase (KEY const &key)
 Return a reference to a WrapperBase stored in this group. More...
 
indexType getWrapperIndex (string const &name) const
 
wrapperMap const & wrappers () const
 Get access to the internal wrapper storage. More...
 
wrapperMapwrappers ()
 Get access to the internal wrapper storage. More...
 
indexType numWrappers () const
 Return the number of wrappers. More...
 
std::vector< stringgetWrappersNames () const
 
template<typename LOOKUP_TYPE >
bool hasWrapper (LOOKUP_TYPE const &lookup) const
 Check if a wrapper exists. More...
 
template<typename T , typename LOOKUP_TYPE >
Wrapper< T > const & getWrapper (LOOKUP_TYPE const &index) const
 Retrieve a Wrapper stored in this group. More...
 
template<typename T , typename LOOKUP_TYPE >
Wrapper< T > & getWrapper (LOOKUP_TYPE const &index)
 Retrieve a Wrapper stored in this group. More...
 
template<typename T , typename LOOKUP_TYPE >
Wrapper< T > const * getWrapperPointer (LOOKUP_TYPE const &index) const
 Retrieve a Wrapper stored in this group. More...
 
template<typename T , typename LOOKUP_TYPE >
Wrapper< T > * getWrapperPointer (LOOKUP_TYPE const &index)
 Retrieve a Wrapper stored in this group. More...
 
template<typename T , typename LOOKUP_TYPE >
GEOS_DECLTYPE_AUTO_RETURN getReference (LOOKUP_TYPE const &lookup) const
 Look up a wrapper and get reference to wrapped object. More...
 
template<typename T , typename LOOKUP_TYPE >
T & getReference (LOOKUP_TYPE const &lookup)
 Look up a wrapper and get reference to wrapped object. More...
 
virtual void resize (localIndex const newSize)
 Resize the group and all contained wrappers that resize with parent. More...
 
virtual void reserve (indexType const newsize)
 Set the new capacity and reserve it in all wrappers that resize with parent. More...
 
localIndex capacity () const
 Get the "capacity" of the group, which determines the capacity of resizable wrappers. More...
 
localIndex size () const
 Get the "size" of the group, which determines the number of elements in resizable wrappers. More...
 
string const & getName () const
 Get group name. More...
 
string getPath () const
 Return the path of this Group in the data repository. Starts with '/' followed by the hierarchy of the children of the "Problem" in which the Group is. More...
 
DataContext const & getDataContext () const
 
template<typename KEY >
DataContext const & getWrapperDataContext (KEY key) const
 
GroupgetParent ()
 Access the group's parent. More...
 
Group const & getParent () const
 Access the group's parent. More...
 
bool hasParent () const
 
localIndex getIndexInParent () const
 Get the group's index within its parent group. More...
 
localIndex getSubGroupIndex (keyType const &key) const
 Get the index of a sub-Group within this group. More...
 
int sizedFromParent () const
 Check whether this Group is resized when its parent is resized. More...
 
GroupsetSizedFromParent (int val)
 Set whether this wrapper is resized when its parent is resized. More...
 
RestartFlags getRestartFlags () const
 Get flags that control restart output of this group. More...
 
void setRestartFlags (RestartFlags flags)
 Set flags that control restart output of this group. More...
 
InputFlags getInputFlags () const
 Get input flags for schema generation. More...
 
void setInputFlags (InputFlags flags)
 Set input flags for schema generation. More...
 
conduit::Node & getConduitNode ()
 Return the Conduit node object associated with this group. More...
 
conduit::Node const & getConduitNode () const
 Return the Conduit node object associated with this group. More...
 
void prepareToWrite ()
 Register the group and its wrappers with Conduit.
 
void finishWriting ()
 Write the group and its wrappers into Conduit.
 
void loadFromConduit ()
 Read the group and its wrappers from Conduit.
 
void enableLogLevelInput ()
 
void setLogLevel (integer const logLevel)
 Set verbosity level. More...
 
integer getLogLevel () const
 

Static Public Member Functions

static string catalogName ()
 
template<typename LAMBDA >
static void forAllFluxStatWrappers (Group &container, string_view fluxName, LAMBDA &&lambda)
 Apply a functor to all WrappedStats of the given group that target a given flux (and potentially multiple SourceFluxStatsAggregator). The functor takes in parameter the reference to the currently processed WrappedStats. More...
 
- Static Public Member Functions inherited from geos::TaskBase
static CatalogInterface::CatalogTypegetCatalog ()
 Get the catalog interface for the TaskBase. More...
 
- Static Public Member Functions inherited from geos::dataRepository::Group
template<typename T0 , typename T1 , typename ... CASTTYPES, typename CONTAINERTYPE , typename LAMBDA >
static bool applyLambdaToContainer (CONTAINERTYPE &container, LAMBDA &&lambda)
 Apply a given functor to a container if the container can be cast to one of the specified types. More...
 
static CatalogInterface::CatalogTypegetCatalog ()
 Get the singleton catalog for this Group. More...
 

Additional Inherited Members

- Public Types inherited from geos::TaskBase
using CatalogInterface = dataRepository::CatalogInterface< TaskBase, string const &, Group *const >
 The catalog interface type for TaskBase.
 
- Public Types inherited from geos::ExecutableGroup
enum class  TimesteppingBehavior : integer { DeterminesTimeStepSize , DoesNotDetermineTimeStepSize }
 Timestepping type. More...
 
- Public Types inherited from geos::dataRepository::Group
using subGroupMap = MappedVector< Group, Group *, keyType, indexType >
 The template specialization of MappedVector to use for the collection of sub-Group objects.
 
using wrapperMap = MappedVector< WrapperBase, WrapperBase *, keyType, indexType >
 The template specialization of MappedVector to use for the collection wrappers objects.
 
using CatalogInterface = dataRepository::CatalogInterface< Group, string const &, Group *const >
 Type alias for catalog interface used by this class. See CatalogInterface.
 
- Protected Member Functions inherited from geos::FieldStatisticsBase< FlowSolverBase >
void postInputInitialization () override
 
- Protected Member Functions inherited from geos::dataRepository::Group
virtual void initializePreSubGroups ()
 Called by Initialize() prior to initializing sub-Groups.
 
virtual void initializePostSubGroups ()
 Called by Initialize() after to initializing sub-Groups.
 
virtual void initializePostInitialConditionsPreSubGroups ()
 Called by InitializePostInitialConditions() prior to initializing sub-Groups.
 
virtual void initializePostInitialConditionsPostSubGroups ()
 Called by InitializePostInitialConditions() after to initializing sub-Groups.
 
virtual void postRestartInitialization ()
 Performs initialization required after reading from a restart file.
 
- Protected Attributes inherited from geos::FieldStatisticsBase< FlowSolverBase >
FlowSolverBasem_solver
 Pointer to the physics solver.
 
string const m_outputDir
 
integer m_writeCSV
 

Detailed Description

Task class allowing for the computation of aggregate statistics of SourceFluxBoundaryCondition

Definition at line 36 of file SourceFluxStatistics.hpp.

Constructor & Destructor Documentation

◆ SourceFluxStatsAggregator()

geos::SourceFluxStatsAggregator::SourceFluxStatsAggregator ( const string name,
Group *const  parent 
)

Constructor for the statistics class.

Parameters
[in]namethe name of the task coming from the xml
[in]parentthe parent group of the task

Member Function Documentation

◆ catalogName()

static string geos::SourceFluxStatsAggregator::catalogName ( )
inlinestatic
Returns
The catalog name

Definition at line 211 of file SourceFluxStatistics.hpp.

◆ execute()

virtual bool geos::SourceFluxStatsAggregator::execute ( real64 const  time_n,
real64 const  dt,
integer const  cycleNumber,
integer const  eventCounter,
real64 const  eventProgress,
DomainPartition domain 
)
overridevirtual

Main extension point of executable targets.

Parameters
[in]time_ncurrent time level
[in]dttime step to be taken
[in]cycleNumberglobal cycle number
[in]eventCounterindex of event that triggered execution
[in]eventProgressfractional progress in current cycle
[in,out]domainthe physical domain up-casted to a Group.
Returns
True iff this event requires exiting the event loop.

If the start criteria are satisfied, then the event manager will call this method.

Implements geos::FieldStatisticsBase< FlowSolverBase >.

◆ forAllFluxStatsWrappers()

template<typename LAMBDA >
void geos::SourceFluxStatsAggregator::forAllFluxStatsWrappers ( MeshLevel meshLevel,
LAMBDA &&  lambda 
)

Apply a functor to each WrappedStats that combines the stats over all region for a flux.

Parameters
meshLevelthe mesh level for which we want the statistics.
lambdathe functor that will be called for each WrappedStats. Takes in parameter the MeshLevel reference and the reference to one of the flux WrappedStats.
Template Parameters
LAMBDAthe type of lambda function to call in the function
Note
To be retrieved, the WrappedStats structs must be registered on the container during the registerDataOnMesh() call.

Definition at line 377 of file SourceFluxStatistics.hpp.

◆ forAllFluxStatWrappers()

template<typename LAMBDA >
void geos::SourceFluxStatsAggregator::forAllFluxStatWrappers ( Group container,
string_view  fluxName,
LAMBDA &&  lambda 
)
static

Apply a functor to all WrappedStats of the given group that target a given flux (and potentially multiple SourceFluxStatsAggregator). The functor takes in parameter the reference to the currently processed WrappedStats.

Note
To be retrieved, the WrappedStats structs must be registered on the container during the registerDataOnMesh() call.
Template Parameters
LAMBDAthe type of lambda function to call in the function
Parameters
containerthe container from which we want the statistics.
fluxNamethe name of the flux from which we want the statistics.
lambdathe functor that will be called for each WrappedStats. Takes in parameter the reference to the currently processed WrappedStats.

Definition at line 348 of file SourceFluxStatistics.hpp.

◆ forAllRegionStatsWrappers()

template<typename LAMBDA >
void geos::SourceFluxStatsAggregator::forAllRegionStatsWrappers ( MeshLevel meshLevel,
string_view  fluxName,
LAMBDA &&  lambda 
)

Apply a functor to all simulated region WrappedStats (of the given MeshLevel) that target a given flux.

Parameters
meshLevelthe mesh level we want to loop over all its regions.
fluxNamethe name of the flux from which we want the statistics.
lambdathe functor that will be called for each WrappedStats. Takes in parameter the ElementRegionBase reference and the reference of its WrappedStats.
Template Parameters
LAMBDAthe type of lambda function to call in the function
Note
To be retrieved, the WrappedStats structs must be registered on the container during the registerDataOnMesh() call.

Definition at line 389 of file SourceFluxStatistics.hpp.

◆ forAllSubRegionStatsWrappers()

template<typename LAMBDA >
void geos::SourceFluxStatsAggregator::forAllSubRegionStatsWrappers ( ElementRegionBase region,
string_view  fluxName,
LAMBDA &&  lambda 
)

Apply a functor to all subregion WrappedStats (of the given region) that target a given flux.

Parameters
regionthe region from which we want to execute the lambda for each of its sub-region.
fluxNamethe name of the flux from which we want the statistics.
lambdathe functor that will be called for each WrappedStats. Takes in parameter the ElementSubRegionBase reference and the reference of its WrappedStats.
Template Parameters
LAMBDAthe type of lambda function to call in the function
Note
To be retrieved, the WrappedStats structs must be registered on the container during the registerDataOnMesh() call.

Definition at line 402 of file SourceFluxStatistics.hpp.

◆ forMeshLevelStatsWrapper()

template<typename LAMBDA >
void geos::SourceFluxStatsAggregator::forMeshLevelStatsWrapper ( DomainPartition domain,
LAMBDA &&  lambda 
)

Apply a functor to WrappedStats that combines all stats for each target solver discretization mesh levels.

Parameters
domainthe domain for which we want the statistics
lambdathe functor that will be called for each WrappedStats. Takes in parameter the MeshLevel reference and the reference to the WrappedStats that combines all stats for the instance.
Template Parameters
LAMBDAthe type of lambda function to call in the function
Note
To be retrieved, the WrappedStats structs must be registered on the container during the registerDataOnMesh() call.

Definition at line 362 of file SourceFluxStatistics.hpp.

◆ getStatWrapperName()

string geos::SourceFluxStatsAggregator::getStatWrapperName ( string_view  fluxName) const
inline
Returns
a string used to name the wrapper that is added to each region that is simulated by the solver. The string is unique within the region for the SourceFluxBoundaryCondition and the SourceFluxStatsAggregator.
Parameters
fluxNameThe name of the flux. For the mesh-level global stats, fluxSetWrapperString() can be used.

Definition at line 415 of file SourceFluxStatistics.hpp.


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