#include <FieldSpecificationManager.hpp>

Inheritance diagram for geosx::FieldSpecificationManager:

Public Member Functions
virtual Group *	CreateChild (string const &childKey, string const &childName) override
	Create a new FieldSpecificationBase object as a child of this group. More...

virtual void	ExpandObjectCatalogs () override
	This function is used to expand any catalogs in the data structure.

template<typename POLICY = parallelHostPolicy>
void	ApplyFieldValue (real64 const time, dataRepository::Group *domain, string const &fieldPath, string const &fieldName) const
	Function to apply a value directly to a field variable. More...

template<typename POLICY = parallelHostPolicy, typename LAMBDA = void>
void	ApplyFieldValue (real64 const time, dataRepository::Group *domain, string const &fieldPath, string const &fieldName, LAMBDA &&lambda) const
	Function to apply a value directly to a field variable and applies a lambda for any post operations that are needed. More...

template<typename POLICY = parallelHostPolicy, typename PRELAMBDA = void, typename POSTLAMBDA = void>
void	ApplyFieldValue (real64 const time, dataRepository::Group *domain, string const &fieldPath, string const &fieldName, PRELAMBDA &&preLambda, POSTLAMBDA &&postLambda) const
	Function to apply a value directly to a field variable and applies a lambda for any post operations that are needed. More...

void	ApplyInitialConditions (dataRepository::Group *domain) const
	function to apply initial conditions More...

template<typename LAMBDA >
void	Apply (real64 const time, dataRepository::Group *domain, string const &fieldPath, string const &fieldName, LAMBDA &&lambda) const
	This function is the main driver for the field applications. More...

Public Member Functions inherited from geosx::dataRepository::Group
	Group (std::string const &name, Group *const parent)
	Constructor. More...

	Group (Group &&source)
	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.

	Group (Group const &&)=delete
	Deleted move constructor.

Group &	operator= (Group const &)=delete
	Deleted copy assignment operator. More...

Group &	operator= (Group &&)=delete
	Deleted move assignment operator. More...

virtual const std::type_info &	get_typeid () const
	Get typeid for current group. More...

bool	CheckTypeID (std::type_info const &typeToCheck) const
	Check a type_info against the type_info of this Group. More...

void	PrintDataHierarchy (integer indent=0)
	Prints the data hierarchy recursively. More...

string	dumpInputOptions () const

template<typename T = Group>
T *	RegisterGroup (std::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 (std::string const &name, T *newObject)
	Register a new Group as a sub-group of current Group. More...

template<typename T = Group>
T *	RegisterGroup (std::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 (std::string const &name, std::string const &catalogName)
	Register a new Group as a sub-group of current Group. More...

void	deregisterGroup (std::string const &name)
	Removes a child group from this group. More...

template<typename T = Group>
T *	GetGroup (localIndex index)
	Retrieve a sub-group from the current Group using an index. More...

template<typename T = Group>
T const *	GetGroup (localIndex index) const
	Retrieve a sub-group from the current Group using an index. More...

template<typename T = Group>
T *	GetGroup (string const &name)
	Retrieve a sub-group from the current Group using a string. More...

template<typename T = Group>
T const *	GetGroup (string const &name) const
	Retrieve a sub-group from the current Group using a string. More...

template<typename T = Group>
T &	getGroupReference (string const &key)

template<typename T = Group>
T const &	getGroupReference (string const &key) const

template<typename T = Group>
T &	GetGroupReference (subGroupMap::KeyIndex const &key)

template<typename T = Group>
T const &	GetGroupReference (subGroupMap::KeyIndex const &key) const

template<typename T = Group>
T *	GetGroup (subGroupMap::KeyIndex const &key)
	Retrieve a sub-group from the current Group using a KeyIndexT. More...

template<typename T = Group>
T const *	GetGroup (subGroupMap::KeyIndex const &key) const
	Retrieve a sub-group from the current Group using a KeyIndexT. 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...

subGroupMap &	GetSubGroups ()
	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...

bool	hasGroup (std::string const &name) const
	Check whether a sub-group exists. 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 LOOKUP_CONTAINER , typename LAMBDA >
void	forSubGroups (LOOKUP_CONTAINER const &subGroupKeys, LAMBDA lambda)

template<typename GROUPTYPE = Group, typename ... GROUPTYPES, typename LOOKUP_CONTAINER , typename LAMBDA >
void	forSubGroups (LOOKUP_CONTAINER const &subGroupKeys, LAMBDA lambda) const

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...

void	Initialize (Group *const group)
	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 (Group *const group)
	Initialization routine to be called after calling ApplyInitialConditions(). More...

void	postRestartInitializationRecursive (Group *const domain)
	Initialization routine to be called after calling reading a restart file. More...

void	ProcessInputFileRecursive (xmlWrapper::xmlNode &targetNode)
	Recursively read values using ProcessInputFile() from the input file and put them into the wrapped values for this group. More...

void	PostProcessInputRecursive ()
	Recursively call PostProcessInput() to apply post processing after reading input values.

template<typename T , typename TBASE = T>
Wrapper< TBASE > *	registerWrapper (std::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)

template<typename T >
Wrapper< T > *	registerWrapper (std::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 (std::string const &name, T *newObject)
	Register a Wrapper around an existing object, does not take ownership of the object. More...

WrapperBase *	registerWrapper (string const &name, 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	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 *const meshBodies)
	Calls RegisterDataOnMesh() recursively. More...

virtual void	RegisterDataOnMesh (Group *const meshBodies)
	Register data on mesh entities. More...

virtual localIndex	PackSize (string_array const &wrapperNames, integer const recursive, bool on_device=false) 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 on_device=false) const
	Get the size required to pack a list of indices within a list of wrappers. More...

virtual localIndex	Pack (buffer_unit_type *&buffer, string_array const &wrapperNames, integer const recursive, bool on_device=false) 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 on_device=false) const
	Pack a list of indices within a list of wrappers. More...

virtual localIndex	Unpack (buffer_unit_type const *&buffer, arrayView1d< localIndex > &packList, integer const recursive, bool on_device=false)
	Unpack a buffer. More...

WrapperBase const *	getWrapperBase (indexType const index) const
	Retrieve a WrapperBase stored in this group. More...

WrapperBase *	getWrapperBase (indexType const index)
	Retrieve a WrapperBase stored in this group. More...

WrapperBase const *	getWrapperBase (std::string const &name) const
	Retrieve a WrapperBase stored in this group. More...

WrapperBase *	getWrapperBase (std::string const &name)
	Retrieve a WrapperBase stored in this group. More...

WrapperBase const *	getWrapperBase (wrapperMap::KeyIndex const &keyIndex) const
	Retrieve a WrapperBase stored in this group. More...

WrapperBase *	getWrapperBase (wrapperMap::KeyIndex const &keyIndex)
	Retrieve a WrapperBase stored in this group. More...

indexType	getWrapperIndex (std::string const &name) const

wrapperMap const &	wrappers () const
	Get access to the internal wrapper storage. More...

wrapperMap &	wrappers ()
	Get access to the internal wrapper storage. More...

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 >
Wrapper< T > const *	getWrapper (char const *const key) const
	Retrieve a Wrapper stored in this group. More...

template<typename T >
Wrapper< T > *	getWrapper (char const *const key)
	Retrieve a Wrapper stored in this group. More...

template<typename T , typename LOOKUP_TYPE >
GEOSX_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...

template<typename T >
GEOSX_DECLTYPE_AUTO_RETURN	getReference (char const *const name) const

template<typename T >
T &	getReference (char const *const name)

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...

const string	getName () const
	Get group name. More...

Group *	getParent ()
	Access the group's parent. More...

Group const *	getParent () const
	Access the group's parent. More...

localIndex	getIndexInParent () const
	Get the group's index withing its parent group. More...

integer	sizedFromParent () const
	Check whether this Group is resized when its parent is resized. More...

Group *	setSizedFromParent (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 ()
	Get 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 ()
	Enable verbosity input for object.

integer	getLogLevel () const

template<typename T >
T	group_cast ()
	Downcast this Group. More...

template<typename T >
T	group_cast () const
	Downcast this Group. More...

Static Public Member Functions
static FieldSpecificationManager &	get ()
	Singleton getter returns a pointer to the Singleton instance of FieldSpecificationManager. More...

Static Public Member Functions inherited from geosx::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::CatalogType &	GetCatalog ()
	Get the singleton catalog for this class. More...

template<typename T >
static T	group_cast (Group *group)
	Downcast a Group *. More...

template<typename T >
static T	group_cast (Group const *group)
	Downcast a Group const *. More...

Additional Inherited Members
Public Types inherited from geosx::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, std::string const &, Group *const >
	Type alias for catalog interface used by this class. See CatalogInterface.

Protected Member Functions inherited from geosx::dataRepository::Group
virtual void	PostProcessInput ()

virtual void	InitializePreSubGroups (Group *const group)
	Called by Initialize() prior to initializing sub-Groups. More...

virtual void	InitializePostSubGroups (Group *const group)
	Called by Initialize() after to initializing sub-Groups. More...

virtual void	InitializePostInitialConditions_PreSubGroups (Group *const group)
	Called by InitializePostInitialConditions() prior to initializing sub-Groups. More...

virtual void	InitializePostInitialConditions_PostSubGroups (Group *const group)
	Called by InitializePostInitialConditions() after to initializing sub-Groups. More...

virtual void	postRestartInitialization (Group *const domain)
	Performs initialization required after reading from a restart file. More...

Detailed Description

This class contains the field objects and provides an interface for administering to specify them The class is a singleton.

Definition at line 48 of file FieldSpecificationManager.hpp.

Member Function Documentation

◆ Apply()

template<typename LAMBDA >

void geosx::FieldSpecificationManager::Apply	(	real64 const	time,
		dataRepository::Group *	domain,
		string const &	fieldPath,
		string const &	fieldName,
		LAMBDA &&	lambda
	)		const

inline

This function is the main driver for the field applications.

Template Parameters

LAMBDA The type of the lambda function

Parameters

time	The time at which the field will be evaluated. For instance if the field is a time dependent function, this is the evaluation time.
domain	The DomainPartition object.
fieldPath	The path to the object that contains the variable described in fieldName. This path need not be the complete path, but rather the check that is performed is that the fieldPath specified is contained in the string that specifies the path from the actual field specification. In other words, the fieldPath variable can be a substring of the path specified, and that will be sufficient to proceed with the application of the value to the field.
fieldName	The name of the field/variable that the value will be applied to. It may not be necessary that this name is in the data repository, as the user supplied lambda may apply whatever it condition it would like. However, this name is used for comparing against the value given in the specification.
lambda	A lambda function that defines the application of the field.

This function loops through all available fields, checks to see if they should be applied, and applies them. More specifically, this function simply checks values of fieldPath,fieldName, against each FieldSpecificationBase object contained in the FieldSpecificationManager and decides on whether or not to call the user defined lambda.

Definition at line 219 of file FieldSpecificationManager.hpp.

◆ ApplyFieldValue() [1/3]

template<typename POLICY = parallelHostPolicy>

void geosx::FieldSpecificationManager::ApplyFieldValue	(	real64 const	time,
		dataRepository::Group *	domain,
		string const &	fieldPath,
		string const &	fieldName
	)		const

inline

Function to apply a value directly to a field variable.

Template Parameters

LAMBDA The type of the lambda function

Parameters

time	The time at which the value will be evaluated. For instance if the field is a time dependent function, this is the evaluation time.
domain	The DomainPartition object.
fieldPath	The path to the object that contains the variable described in fieldName. This path need not be the complete path, but rather the check that is performed is that the fieldPath specified is contained in the string that specifies the path from the actual field specification. In other words, the fieldPath variable can be a substring of the path specified, and that will be sufficient to proceed with the application of the.
fieldName	The name of the field/variable that the value will be applied to. It may not be necessary that this name is in the data repository, as the user supplied lambda may apply whatever it condition it would like. However, this name is used for comparing against the value given in the field specification.

Interface function that applies a boundary condition directly to a field variable by looping through all FieldSpecificationBase objects present in the FieldSpecificationManager. Searches for the string specified in fieldPath as a substring in the objectPath specified in the input file, checks if fieldName is equal to the fieldName specified in the input file, and check if the time parameter falls within the beginTime and endTime of the FieldSpecificationBase object, and calls FieldSpecificationBase::ApplyFieldValue().

Definition at line 97 of file FieldSpecificationManager.hpp.

◆ ApplyFieldValue() [2/3]

template<typename POLICY , typename LAMBDA >

void geosx::FieldSpecificationManager::ApplyFieldValue	(	real64 const	time,
		dataRepository::Group *	domain,
		string const &	fieldPath,
		string const &	fieldName,
		LAMBDA &&	lambda
	)		const

Function to apply a value directly to a field variable and applies a lambda for any post operations that are needed.

Template Parameters

LAMBDA The type of the lambda function

Parameters

time	The time at which the field will be evaluated. For instance if the field is a time dependent function, this is the evaluation time.
domain	The DomainPartition object.
fieldPath	The path to the object that contains the variable described in fieldName. This path need not be the complete path, but rather the check that is performed is that the fieldPath specified is contained in the string that specifies the path from the actual field specification. In other words, the fieldPath variable can be a substring of the path specified , and that will be sufficient to proceed with the application of the value.
fieldName	The name of the field/variable that the value will be applied to. It may not be necessary that this name is in the data repository, as the user supplied lambda may apply whatever it condition it would like. However, this name is used for comparing against the value given in the field specification.
lambda	A lambda function that defines any operations that should be performed after application of value to the field.

Interface function that applies a value directly to a field by looping through all FieldSpecificationBase objects present in the FieldSpecificationManager. Searches for the string specified in fieldPath as a substring in the objectPath specified in the input file, checks if fieldName is equal to the fieldName specified in the input file, and check if the time parameter falls within the beginTime and endTime of the FieldSpecificationBase object, and calls FieldSpecificationBase::ApplyFieldValue(), and calls the lambda function to apply any operations required for completing the application of the value to the field in addition to setting the target field.

Definition at line 329 of file FieldSpecificationManager.hpp.

◆ ApplyFieldValue() [3/3]

template<typename POLICY , typename PRELAMBDA , typename POSTLAMBDA >

void geosx::FieldSpecificationManager::ApplyFieldValue	(	real64 const	time,
		dataRepository::Group *	domain,
		string const &	fieldPath,
		string const &	fieldName,
		PRELAMBDA &&	preLambda,
		POSTLAMBDA &&	postLambda
	)		const

Function to apply a value directly to a field variable and applies a lambda for any post operations that are needed.

Template Parameters

PRELAMBDA	The type of the lambda function to be called before the ApplyFieldValue
POSTLAMBDA	The type of the lambda function to be called after the ApplyFieldValue

Parameters

time	The time at which the field will be evaluated. For instance if the field is a time dependent function, this is the evaluation time.
domain	The DomainPartition object.
fieldPath	The path to the object that contains the variable described in fieldName. This path need not be the complete path, but rather the check that is performed is that the fieldPath specified is contained in the string that specifies the path from the actual field specification. In other words, the fieldPath variable can be a substring of the path specified , and that will be sufficient to proceed with the application of the value.
fieldName	The name of the field/variable that the value will be applied to. It may not be necessary that this name is in the data repository, as the user supplied lambda may apply whatever it condition it would like. However, this name is used for comparing against the value given in the field specification.
preLambda	A lambda function that defines any operations that should be performed before application of value to the field.
postLambda	A lambda function that defines any operations that should be performed after application of value to the field.

Interface function that applies a value directly to a field by looping through all FieldSpecificationBase objects present in the FieldSpecificationManager. Calls the preLambda function to apply any operations required before the application of the value to the field in addition to setting the target field. Searches for the string specified in fieldPath as a substring in the objectPath specified in the input file, checks if fieldName is equal to the fieldName specified in the input file, and check if the time parameter falls within the beginTime and endTime of the FieldSpecificationBase object, and calls FieldSpecificationBase::ApplyFieldValue(), and calls the postLambda function to apply any operations required for completing the application of the value to the field in addition to setting the target field.

Definition at line 352 of file FieldSpecificationManager.hpp.

◆ ApplyInitialConditions()

void geosx::FieldSpecificationManager::ApplyInitialConditions ( dataRepository::Group * domain ) const

function to apply initial conditions

Parameters

domain the DomainParition object

◆ CreateChild()

virtual Group* geosx::FieldSpecificationManager::CreateChild	(	string const &	childKey,
		string const &	childName
	)

overridevirtual

Create a new FieldSpecificationBase object as a child of this group.

Parameters

childKey	the catalog key of the new FieldSpecificationBase derived type to create
childName	the name of the new FieldSpecificationBase object in the repository

Returns: the group child

Reimplemented from geosx::dataRepository::Group.

◆ get()

static FieldSpecificationManager& geosx::FieldSpecificationManager::get ( )

static

Singleton getter returns a pointer to the Singleton instance of FieldSpecificationManager.

Returns: a pointer to the singleton FieldSpecificationManager

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

coreComponents/managers/FieldSpecification/FieldSpecificationManager.hpp

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ Apply()

◆ ApplyFieldValue() [1/3]

◆ ApplyFieldValue() [2/3]

◆ ApplyFieldValue() [3/3]

◆ ApplyInitialConditions()

◆ CreateChild()

◆ get()