#include <FluxApproximationBase.hpp>

Inheritance diagram for geosx::FluxApproximationBase:

Classes
struct	groupKeyStruct
	Group keys. More...

struct	viewKeyStruct
	View keys. More...

Public Types
using	CatalogInterface = dataRepository::CatalogInterface< FluxApproximationBase, string const &, Group *const >
	Alias for CatalogInterface, necessary declarations for factory instantiation of derived classes.

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, string const &, Group *const >
	Type alias for catalog interface used by this class. See CatalogInterface.

Public Member Functions
	FluxApproximationBase (string const &name, dataRepository::Group *const parent)
	Constructor. More...

template<typename TYPE >
TYPE const &	getStencil (MeshLevel const &mesh, string const &name) const
	Extract stencil stored under the mesh group. More...

template<typename TYPE >
TYPE &	getStencil (MeshLevel &mesh, string const &name) const
	Extract stencil stored under the mesh group. More...

template<typename LAMBDA >
void	forAllStencils (MeshLevel const &mesh, LAMBDA &&lambda) const
	Call a user-provided function for each stencil. More...

template<typename TYPE , typename ... TYPES, typename LAMBDA >
void	forStencils (MeshLevel const &mesh, LAMBDA &&lambda) const
	Call a user-provided function for the each stencil according to the provided TYPE. More...

virtual void	addToFractureStencil (MeshLevel &mesh, string const &faceElementRegionName, bool const initFlag) const =0
	Add a new fracture stencil. More...

virtual void	addEmbeddedFracturesToStencils (MeshLevel &mesh, string const &embeddedSurfaceRegionName) const =0
	Add a new embedded fracture stencil. More...

string_array const &	targetRegions () const
	Returns the target region name. More...

string_array &	targetRegions ()
	Returns the target region name. More...

string_array const &	coefficientModelNames () const
	Returns the coeff model name. More...

string_array &	coefficientModelNames ()
	Returns the coeff model name. More...

Public Member Functions inherited from geosx::dataRepository::Group
virtual bool	registerCallback (void *func, const std::type_info &funcType)
	Register a callback function on the group. More...

	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.

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

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

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

string	dumpInputOptions () 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 Group *	createChild (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...

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

template<typename T = Group>
bool	hasGroup (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 ()
	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::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 (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 (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...

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

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

virtual localIndex	unpack (buffer_unit_type const *&buffer, arrayView1d< localIndex > &packList, integer const recursive, bool onDevice, parallelDeviceEvents &events)
	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 >
WrapperBase &	getWrapperBase (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...

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

indexType	numWrappers () const
	Return the number of wrappers. 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 , 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 >
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...

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

integer	getLogLevel () const

Static Public Member Functions
static CatalogInterface::CatalogType &	getCatalog ()
	Return the data type in the data repository. 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...

Protected Member Functions
virtual void	registerDataOnMesh (Group &meshBodies) override
	Register data on mesh entities. More...

virtual void	initializePostInitialConditionsPreSubGroups () override
	Called by InitializePostInitialConditions() prior to initializing sub-Groups.

virtual void	registerCellStencil (Group &stencilGroup) const =0
	Register the wrapper for cell stencil on a mesh. More...

virtual void	computeCellStencil (MeshLevel &mesh) const =0
	Actual computation of the cell-to-cell stencil, to be overridden by implementations. More...

virtual void	registerFractureStencil (Group &stencilGroup) const =0
	Register the wrapper for fracture stencil on a mesh. More...

virtual void	registerBoundaryStencil (Group &stencilGroup, string const &setName) const =0
	Register the wrapper for boundary face stencil on a mesh. More...

virtual void	computeBoundaryStencil (MeshLevel &mesh, string const &setName, SortedArrayView< localIndex const > const &faceSet) const =0
	Allocate and populate a stencil to be used in dirichlet boundary condition application. More...

virtual void	registerAquiferStencil (Group &stencilGroup, string const &setName) const =0
	Register the wrapper for aquifer stencil on a mesh. More...

virtual void	computeAquiferStencil (DomainPartition &domain, MeshLevel &mesh) const =0
	Allocate and populate a stencil to be used in aquifer boundary condition application. More...

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

virtual void	initializePreSubGroups ()
	Called by Initialize() prior to initializing sub-Groups.

virtual void	initializePostSubGroups ()
	Called by Initialize() after 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
string	m_fieldName
	name of the primary solution field

string	m_coeffName
	name of the coefficient field

string_array	m_coefficientModelNames
	names of coefficient models to build the stencil for

string_array	m_targetRegions
	names of target regions to build the stencil for

real64	m_areaRelTol
	relative tolerance

real64	m_lengthScale
	length scale of the mesh body

Detailed Description

Base class for various flux approximation classes. Stores the main and boundary stencils, construction is implemented in derived classes. Main stencil is the one for cell-to-cell fluxes. Boundary stencils are for Dirichlet boundary conditions

Definition at line 43 of file FluxApproximationBase.hpp.

Constructor & Destructor Documentation

◆ FluxApproximationBase()

geosx::FluxApproximationBase::FluxApproximationBase	(	string const &	name,
		dataRepository::Group *const	parent
	)

Constructor.

Parameters

name	the name of the FluxApproximationBase in the data repository
parent	the parent group of this group.

Member Function Documentation

◆ addEmbeddedFracturesToStencils()

virtual void geosx::FluxApproximationBase::addEmbeddedFracturesToStencils	(	MeshLevel &	mesh,
		string const &	embeddedSurfaceRegionName
	)		const

pure virtual

Add a new embedded fracture stencil.

Parameters

[in,out]	mesh	the mesh on which to add the fracture stencil
[in]	embeddedSurfaceRegionName	the embedded surface element region name

Implemented in geosx::TwoPointFluxApproximation.

◆ addToFractureStencil()

virtual void geosx::FluxApproximationBase::addToFractureStencil	(	MeshLevel &	mesh,
		string const &	faceElementRegionName,
		bool const	initFlag
	)		const

pure virtual

Add a new fracture stencil.

Parameters

[in,out]	mesh	the mesh on which to add the fracture stencil
[in]	faceElementRegionName	the face element region name
[in]	initFlag	if true initialize physical fields, like pressure

Implemented in geosx::TwoPointFluxApproximation.

◆ coefficientModelNames() [1/2]

string_array const& geosx::FluxApproximationBase::coefficientModelNames ( ) const

inline

Returns the coeff model name.

Returns: the coeff model name

Definition at line 174 of file FluxApproximationBase.hpp.

◆ coefficientModelNames() [2/2]

string_array& geosx::FluxApproximationBase::coefficientModelNames ( )

inline

Returns the coeff model name.

Returns: the coeff model name

Definition at line 178 of file FluxApproximationBase.hpp.

◆ computeAquiferStencil()

virtual void geosx::FluxApproximationBase::computeAquiferStencil	(	DomainPartition &	domain,
		MeshLevel &	mesh
	)		const

protectedpure virtual

Allocate and populate a stencil to be used in aquifer boundary condition application.

Parameters

domain	the domain partion
mesh	the target mesh level

Implemented in geosx::TwoPointFluxApproximation.

◆ computeBoundaryStencil()

virtual void geosx::FluxApproximationBase::computeBoundaryStencil	(	MeshLevel &	mesh,
		string const &	setName,
		SortedArrayView< localIndex const > const &	faceSet
	)		const

protectedpure virtual

Allocate and populate a stencil to be used in dirichlet boundary condition application.

Parameters

mesh	the target mesh level
setName	name of the face set, to be used as wrapper name for the produced stencil
faceSet	set of face indices to use

Implemented in geosx::TwoPointFluxApproximation.

◆ computeCellStencil()

virtual void geosx::FluxApproximationBase::computeCellStencil ( MeshLevel & mesh ) const

protectedpure virtual

Actual computation of the cell-to-cell stencil, to be overridden by implementations.

Parameters

[in] mesh the mesh on which to perform the computation

Implemented in geosx::TwoPointFluxApproximation.

◆ forAllStencils()

template<typename LAMBDA >

void geosx::FluxApproximationBase::forAllStencils	(	MeshLevel const &	mesh,
		LAMBDA &&	lambda
	)		const

Call a user-provided function for each stencil.

Template Parameters

LAMBDA The type of lambda function passed into the parameter list.

Parameters

[in]	mesh	the mesh level containing the stencils
[in]	lambda	The LAMBDA function

Definition at line 276 of file FluxApproximationBase.hpp.

◆ forStencils()

template<typename TYPE , typename ... TYPES, typename LAMBDA >

void geosx::FluxApproximationBase::forStencils	(	MeshLevel const &	mesh,
		LAMBDA &&	lambda
	)		const

Call a user-provided function for the each stencil according to the provided TYPE.

Template Parameters

TYPE	The type to be passed to forWrappers
TYPES	Other types to be passed to forWrappers
LAMBDA	The type of lambda function passed into the parameter list.

Parameters

[in]	mesh	the mesh level containing the stencils
[in]	lambda	The LAMBDA function

Definition at line 286 of file FluxApproximationBase.hpp.

◆ getCatalog()

static CatalogInterface::CatalogType& geosx::FluxApproximationBase::getCatalog ( )

static

Return the data type in the data repository.

Returns: the data type in the data repository

◆ getStencil() [1/2]

template<typename TYPE >

TYPE const & geosx::FluxApproximationBase::getStencil	(	MeshLevel const &	mesh,
		string const &	name
	)		const

Extract stencil stored under the mesh group.

Template Parameters

TYPE	type of Stencil to get

Parameters

mesh	the mesh level object
name	name of the stencil object

Returns: reference to the stencil

Definition at line 262 of file FluxApproximationBase.hpp.

◆ getStencil() [2/2]

template<typename TYPE >

TYPE & geosx::FluxApproximationBase::getStencil	(	MeshLevel &	mesh,
		string const &	name
	)		const

Extract stencil stored under the mesh group.

Template Parameters

TYPE	type of Stencil to get

Parameters

mesh	the mesh level object
name	name of the stencil object

Returns: reference to the stencil

Definition at line 269 of file FluxApproximationBase.hpp.

◆ registerAquiferStencil()

virtual void geosx::FluxApproximationBase::registerAquiferStencil	(	Group &	stencilGroup,
		string const &	setName
	)		const

protectedpure virtual

Register the wrapper for aquifer stencil on a mesh.

Parameters

stencilGroup	the group holding the stencil objects
setName	the face set name (used as the wrapper name)

Implemented in geosx::TwoPointFluxApproximation.

◆ registerBoundaryStencil()

virtual void geosx::FluxApproximationBase::registerBoundaryStencil	(	Group &	stencilGroup,
		string const &	setName
	)		const

protectedpure virtual

Register the wrapper for boundary face stencil on a mesh.

Parameters

stencilGroup	the group holding the stencil objects
setName	the face set name (used as the wrapper name)

Implemented in geosx::TwoPointFluxApproximation.

◆ registerCellStencil()

virtual void geosx::FluxApproximationBase::registerCellStencil ( Group & stencilGroup ) const

protectedpure virtual

Register the wrapper for cell stencil on a mesh.

Parameters

stencilGroup the group holding the stencil objects

Implemented in geosx::TwoPointFluxApproximation.

◆ registerDataOnMesh()

virtual void geosx::FluxApproximationBase::registerDataOnMesh ( Group & meshBodies )

overrideprotectedvirtual

Register data on mesh entities.

Parameters

[in,out] meshBodies the group of MeshBody objects to register data on.

This function is used to register data on mesh entities such as the NodeManager, FaceManager...etc.

Reimplemented from geosx::dataRepository::Group.

◆ registerFractureStencil()

virtual void geosx::FluxApproximationBase::registerFractureStencil ( Group & stencilGroup ) const

protectedpure virtual

Register the wrapper for fracture stencil on a mesh.

Parameters

stencilGroup the group holding the stencil objects

Implemented in geosx::TwoPointFluxApproximation.

◆ targetRegions() [1/2]

string_array const& geosx::FluxApproximationBase::targetRegions ( ) const

inline

Returns the target region name.

Returns: the target region name

Definition at line 164 of file FluxApproximationBase.hpp.

◆ targetRegions() [2/2]

string_array& geosx::FluxApproximationBase::targetRegions ( )

inline

Returns the target region name.

Returns: the target region name

Definition at line 168 of file FluxApproximationBase.hpp.

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

coreComponents/finiteVolume/FluxApproximationBase.hpp

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ FluxApproximationBase()

Member Function Documentation

◆ addEmbeddedFracturesToStencils()

◆ addToFractureStencil()

◆ coefficientModelNames() [1/2]

◆ coefficientModelNames() [2/2]

◆ computeAquiferStencil()

◆ computeBoundaryStencil()

◆ computeCellStencil()

◆ forAllStencils()

◆ forStencils()

◆ getCatalog()

◆ getStencil() [1/2]

◆ getStencil() [2/2]

◆ registerAquiferStencil()

◆ registerBoundaryStencil()

◆ registerCellStencil()

◆ registerDataOnMesh()

◆ registerFractureStencil()

◆ targetRegions() [1/2]

◆ targetRegions() [2/2]