GEOSX
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
geosx::TwoPointFluxApproximation Class Reference

#include <TwoPointFluxApproximation.hpp>

Inheritance diagram for geosx::TwoPointFluxApproximation:
Inheritance graph
[legend]

Public Member Functions

 TwoPointFluxApproximation (std::string const &name, dataRepository::Group *const parent)
 Constructor. More...
 
- Public Member Functions inherited from geosx::FluxApproximationBase
 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...
 
string_array const & targetRegions () const
 Returns the target region name. More...
 
string_arraytargetRegions ()
 Returns the target region name. 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.
 
Groupoperator= (Group const &)=delete
 Deleted copy assignment operator. More...
 
Groupoperator= (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...
 
virtual GroupCreateChild (string const &childKey, string const &childName)
 Creates a new sub-Group using the ObjectCatalog functionality. 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...
 
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...
 
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...
 
WrapperBaseregisterWrapper (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 *const meshBodies)
 Calls RegisterDataOnMesh() recursively. 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...
 
WrapperBasegetWrapperBase (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...
 
WrapperBasegetWrapperBase (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...
 
WrapperBasegetWrapperBase (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...
 
wrapperMapwrappers ()
 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...
 
GroupgetParent ()
 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...
 
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 ()
 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 >
group_cast ()
 Downcast this Group. More...
 
template<typename T >
group_cast () const
 Downcast this Group. More...
 

Static Public Member Functions

static std::string CatalogName ()
 Static Factory Catalog Functions. More...
 
- Static Public Member Functions inherited from geosx::FluxApproximationBase
static CatalogInterface::CatalogTypeGetCatalog ()
 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::CatalogTypeGetCatalog ()
 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...
 

Protected Member Functions

virtual void registerCellStencil (Group &stencilGroup) const override
 Register the wrapper for cell stencil on a mesh. More...
 
virtual void computeCellStencil (MeshLevel &mesh) const override
 Actual computation of the cell-to-cell stencil, to be overridden by implementations. More...
 
virtual void registerFractureStencil (Group &stencilGroup) const override
 Register the wrapper for fracture stencil on a mesh. More...
 
virtual void addToFractureStencil (MeshLevel &mesh, string const &faceElementRegionName, bool const initFlag) const override
 Add a new fracture stencil. More...
 
virtual void registerBoundaryStencil (Group &stencilGroup, string const &setName) const override
 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 override
 Allocate and populate a stencil to be used in boundary condition application. More...
 
virtual void addEDFracToFractureStencil (MeshLevel &mesh, string const &embeddedSurfaceRegionName) const override
 Add a new embedded fracture stencil. More...
 
- Protected Member Functions inherited from geosx::FluxApproximationBase
virtual void RegisterDataOnMesh (Group *const meshBodies) override
 Register data on mesh entities. More...
 
virtual void InitializePostInitialConditions_PreSubGroups (Group *const rootGroup) override
 Called by InitializePostInitialConditions() prior to initializing sub-Groups. More...
 
- 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_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::FluxApproximationBase
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, std::string const &, Group *const >
 Type alias for catalog interface used by this class. See CatalogInterface.
 
- Protected Attributes inherited from geosx::FluxApproximationBase
string m_fieldName
 name of the primary solution field
 
string m_coeffName
 name of the coefficient field
 
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

Provides management of the interior stencil points when using a two-point flux approximation.

Definition at line 32 of file TwoPointFluxApproximation.hpp.

Constructor & Destructor Documentation

◆ TwoPointFluxApproximation()

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

Constructor.

Parameters
namethe name of the TwoPointFluxApproximation in the data repository
parentthe parent group of this group.

Member Function Documentation

◆ addEDFracToFractureStencil()

virtual void geosx::TwoPointFluxApproximation::addEDFracToFractureStencil ( MeshLevel mesh,
string const &  embeddedSurfaceRegionName 
) const
overrideprotectedvirtual

Add a new embedded fracture stencil.

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

Implements geosx::FluxApproximationBase.

◆ addToFractureStencil()

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

Add a new fracture stencil.

Parameters
[in,out]meshthe mesh on which to add the fracture stencil
[in]faceElementRegionNamethe face element region name
[in]initFlagif true initialize physical fields, like pressure

Implements geosx::FluxApproximationBase.

◆ CatalogName()

static std::string geosx::TwoPointFluxApproximation::CatalogName ( )
inlinestatic

Static Factory Catalog Functions.

Returns
the catalog name

Definition at line 40 of file TwoPointFluxApproximation.hpp.

◆ computeBoundaryStencil()

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

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

Parameters
meshthe target mesh level
setNamename of the face set, to be used as wrapper name for the produced stencil
faceSetset of face indices to use

Implements geosx::FluxApproximationBase.

◆ computeCellStencil()

virtual void geosx::TwoPointFluxApproximation::computeCellStencil ( MeshLevel mesh) const
overrideprotectedvirtual

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

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

Implements geosx::FluxApproximationBase.

◆ registerBoundaryStencil()

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

Register the wrapper for boundary face stencil on a mesh.

Parameters
stencilGroupthe group holding the stencil objects
setNamethe face set name (used as the wrapper name)

Implements geosx::FluxApproximationBase.

◆ registerCellStencil()

virtual void geosx::TwoPointFluxApproximation::registerCellStencil ( Group stencilGroup) const
overrideprotectedvirtual

Register the wrapper for cell stencil on a mesh.

Parameters
stencilGroupthe group holding the stencil objects

Implements geosx::FluxApproximationBase.

◆ registerFractureStencil()

virtual void geosx::TwoPointFluxApproximation::registerFractureStencil ( Group stencilGroup) const
overrideprotectedvirtual

Register the wrapper for fracture stencil on a mesh.

Parameters
stencilGroupthe group holding the stencil objects

Implements geosx::FluxApproximationBase.


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