This is the class handling the operation flow of the problem being ran in GEOSX. More...

#include <ProblemManager.hpp>

Inheritance diagram for geosx::ProblemManager:

Classes
struct	groupKeysStruct
	Child group viewKeys. More...

struct	viewKeysStruct
	Command line input viewKeys. More...

Public Member Functions
	ProblemManager (const std::string &name, Group *const parent)

	~ProblemManager () override
	Destructor, deletes all Groups and Wrappers owned by this Group.

virtual void	SetSchemaDeviations (xmlWrapper::xmlNode schemaRoot, xmlWrapper::xmlNode schemaParent, integer documentationType) override
	Handles deviations between the data structure and schema. More...

virtual Group *	CreateChild (string const &childKey, string const &childName) override
	Creates a new sub-Group using the ObjectCatalog functionality. More...

void	ParseCommandLineInput ()
	Parses command line input.

void	InitializePythonInterpreter ()
	Initializes a python interpreter within GEOSX. More...

void	ClosePythonInterpreter ()
	Closes the internal python interpreter. More...

void	GenerateDocumentation ()
	Generates the xml schema documentation This function is called when the code is called with the -s schema_name option. More...

void	ParseInputFile ()
	Parses the input xml file. More...

void	GenerateMesh ()
	Generates numerical meshes used throughout the code.

void	ApplyNumericalMethods ()
	Allocates constitutive relations according to the discretizations on each subregion.

void	InitializationOrder (string_array &order) override final
	Defines the order in which objects should be initialized. More...

void	ProblemSetup ()
	Sets up the problem after the input has been read in.

void	RunSimulation ()
	Run the events in the scheduler.

void	ReadRestartOverwrite ()
	After initialization, overwrites data using a restart file.

void	ApplyInitialConditions ()
	Applies initial conditions indicated within the input file FieldSpecifications block.

DomainPartition *	getDomainPartition ()
	Returns a pointer to the DomainPartition. More...

DomainPartition const *	getDomainPartition () const
	Returns a pointer to the DomainPartition. More...

const string &	getProblemName () const
	Returns the problem name. More...

const string &	getInputFileName () const
	Returns the input file name. More...

const string &	getRestartFileName () const
	Returns the restart file name. More...

const string &	getSchemaFileName () const
	Returns the schema file name. More...

PhysicsSolverManager &	GetPhysicsSolverManager ()
	Returns the PhysicsSolverManager. More...

PhysicsSolverManager const &	GetPhysicsSolverManager () const
	Returns the PhysicsSolverManager. 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...

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	ExpandObjectCatalogs ()
	Expand any catalogs in the data structure.

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 bool	ParseRestart (std::string &restartFileName)
	Parses a restart file. 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...

Public Attributes
xmlWrapper::xmlDocument	xmlDocument
	Input file xml document handle.

xmlWrapper::xmlResult	xmlResult
	Input file parsing results.

xmlWrapper::xmlNode	xmlProblemNode
	Input file Problem node handle.

struct geosx::ProblemManager::viewKeysStruct	viewKeys
	Command line input viewKeys.

struct geosx::ProblemManager::groupKeysStruct	groupKeys
	Child group viewKeys.

Protected Member Functions
virtual void	PostProcessInput () override final
	Post process the command line input.

Protected Member Functions inherited from geosx::dataRepository::Group
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...

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.

Detailed Description

This is the class handling the operation flow of the problem being ran in GEOSX.

Definition at line 48 of file ProblemManager.hpp.

Constructor & Destructor Documentation

◆ ProblemManager()

geosx::ProblemManager::ProblemManager	(	const std::string &	name,
		Group *const	parent
	)

explicit

Parameters

name	the name of this object manager
parent	the parent Group

Member Function Documentation

◆ ClosePythonInterpreter()

void geosx::ProblemManager::ClosePythonInterpreter ( )

Closes the internal python interpreter.

Note: This is not regularly used or tested, and may be removed in future versions. To use this feature, the code must be compiled with the GEOSX_USE_PYTHON flag

◆ CreateChild()

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

overridevirtual

Creates a new sub-Group using the ObjectCatalog functionality.

Parameters

childKey	The name of the new object type's key in the ObjectCatalog.
childName	The name of the new object in the collection of sub-Groups.

Returns: A pointer to the new Group created by this function.

Reimplemented from geosx::dataRepository::Group.

◆ GenerateDocumentation()

void geosx::ProblemManager::GenerateDocumentation ( )

Generates the xml schema documentation This function is called when the code is called with the -s schema_name option.

Before generating the schema, the code builds up a comprehensive datastructure. (Note: catalog objects throughout the code will typically be registered via the ExpandObjectCatalogs method.) Once ready, SchemaUtilities will recusively walk through the database, generating the xml schema.

◆ getDomainPartition() [1/2]

DomainPartition* geosx::ProblemManager::getDomainPartition ( )

Returns a pointer to the DomainPartition.

Returns: Pointer to the DomainPartition

◆ getDomainPartition() [2/2]

DomainPartition const* geosx::ProblemManager::getDomainPartition ( ) const

Returns a pointer to the DomainPartition.

Returns: Const pointer to the DomainPartition

◆ getInputFileName()

const string& geosx::ProblemManager::getInputFileName ( ) const

inline

Returns the input file name.

Returns: The input file name

Definition at line 190 of file ProblemManager.hpp.

◆ GetPhysicsSolverManager() [1/2]

PhysicsSolverManager& geosx::ProblemManager::GetPhysicsSolverManager ( )

inline

Returns the PhysicsSolverManager.

Returns: Reference to the PhysicsSolverManager

Definition at line 260 of file ProblemManager.hpp.

◆ GetPhysicsSolverManager() [2/2]

PhysicsSolverManager const& geosx::ProblemManager::GetPhysicsSolverManager ( ) const

inline

Returns the PhysicsSolverManager.

Returns: Const reference to the PhysicsSolverManager

Definition at line 269 of file ProblemManager.hpp.

◆ getProblemName()

const string& geosx::ProblemManager::getProblemName ( ) const

inline

Returns the problem name.

Returns: The problem name

Definition at line 183 of file ProblemManager.hpp.

◆ getRestartFileName()

const string& geosx::ProblemManager::getRestartFileName ( ) const

inline

Returns the restart file name.

Returns: The restart file name

Definition at line 197 of file ProblemManager.hpp.

◆ getSchemaFileName()

const string& geosx::ProblemManager::getSchemaFileName ( ) const

inline

Returns the schema file name.

Returns: The schema file name

Definition at line 204 of file ProblemManager.hpp.

◆ InitializationOrder()

void geosx::ProblemManager::InitializationOrder ( string_array & order )

finaloverridevirtual

Defines the order in which objects should be initialized.

Parameters

order list defining ordering sequence

Reimplemented from geosx::dataRepository::Group.

◆ InitializePythonInterpreter()

void geosx::ProblemManager::InitializePythonInterpreter ( )

Initializes a python interpreter within GEOSX.

Note: This is not regularly used or tested, and may be removed in future versions. To use this feature, the code must be compiled with the GEOSX_USE_PYTHON flag

◆ ParseInputFile()

void geosx::ProblemManager::ParseInputFile ( )

Parses the input xml file.

The name of the input file is indicated via the -i option on the command line

◆ ParseRestart()

static bool geosx::ProblemManager::ParseRestart ( std::string & restartFileName )

static

Parses a restart file.

Parameters

restartFileName the name of the restart file

Returns: flag indicating beginFromRestart status

◆ SetSchemaDeviations()

virtual void geosx::ProblemManager::SetSchemaDeviations	(	xmlWrapper::xmlNode	schemaRoot,
		xmlWrapper::xmlNode	schemaParent,
		integer	documentationType
	)

overridevirtual

Handles deviations between the data structure and schema.

Parameters

schemaRoot	schema root node handle
schemaParent	schema parent node handle
documentationType	flag to indicate the type of schema (0=input, 1=other)

This function handles deviations between the xml and data structure on the Problem level (Functions, Mesh, etc.). This can also be used to add entries to the schema, which are not used during normal code execution (e.g.: Benchmark)

Reimplemented from geosx::dataRepository::Group.

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

coreComponents/managers/ProblemManager.hpp

Classes

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ProblemManager()

Member Function Documentation

◆ ClosePythonInterpreter()

◆ CreateChild()

◆ GenerateDocumentation()

◆ getDomainPartition() [1/2]

◆ getDomainPartition() [2/2]

◆ getInputFileName()

◆ GetPhysicsSolverManager() [1/2]

◆ GetPhysicsSolverManager() [2/2]

◆ getProblemName()

◆ getRestartFileName()

◆ getSchemaFileName()

◆ InitializationOrder()

◆ InitializePythonInterpreter()

◆ ParseInputFile()

◆ ParseRestart()

◆ SetSchemaDeviations()