GEOS
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
geos::FluxApproximationBase Class Referenceabstract

#include <FluxApproximationBase.hpp>

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

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 geos::dataRepository::Group
using subGroupMap = MappedVector< Group, Group *, keyType, indexType >
 The template specialization of MappedVector to use for the collection of sub-Group objects.
 
using wrapperMap = MappedVector< WrapperBase, WrapperBase *, keyType, indexType >
 The template specialization of MappedVector to use for the collection wrappers objects.
 
using CatalogInterface = dataRepository::CatalogInterface< Group, string const &, Group *const >
 Type alias for catalog interface used by this class. See CatalogInterface.
 

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

Static Public Member Functions

static CatalogInterface::CatalogTypegetCatalog ()
 Return the data type in the data repository. More...
 
- Static Public Member Functions inherited from geos::dataRepository::Group
template<typename T0 , typename T1 , typename ... CASTTYPES, typename CONTAINERTYPE , typename LAMBDA >
static bool applyLambdaToContainer (CONTAINERTYPE &container, LAMBDA &&lambda)
 Apply a given functor to a container if the container can be cast to one of the specified types. More...
 
static CatalogInterface::CatalogTypegetCatalog ()
 Get the singleton catalog for this Group. More...
 

Protected Member Functions

virtual void initializePreSubGroups () override
 Called by Initialize() prior to initializing sub-Groups.
 
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. More...
 
virtual void computeFractureStencil (MeshLevel &mesh) const =0
 Actual Computation of the fracture related stencils. 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 geos::dataRepository::Group
virtual void postInputInitialization ()
 
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

array1d< stringm_fieldNames
 name of the primary solution field
 
string m_coeffName
 name of the coefficient field
 
map< string, array1d< string > > 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
 
UpwindingParameters m_upwindingParams
 upwinding parameters
 

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 75 of file FluxApproximationBase.hpp.

Constructor & Destructor Documentation

◆ FluxApproximationBase()

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

Constructor.

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

Member Function Documentation

◆ addEmbeddedFracturesToStencils()

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

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

◆ addFieldName()

void geos::FluxApproximationBase::addFieldName ( string const &  name)

set the name of the field.

Parameters
namename of the field to be set.

◆ addToFractureStencil()

virtual void geos::FluxApproximationBase::addToFractureStencil ( MeshLevel mesh,
string const &  faceElementRegionName 
) const
pure virtual

Add a new fracture stencil.

Parameters
[in,out]meshthe mesh on which to add the fracture stencil
[in]faceElementRegionNamethe face element region name

◆ computeAquiferStencil()

virtual void geos::FluxApproximationBase::computeAquiferStencil ( DomainPartition domain,
MeshLevel mesh 
) const
protectedpure virtual

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

Parameters
domainthe domain partion
meshthe target mesh level

◆ computeBoundaryStencil()

virtual void geos::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
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

◆ computeCellStencil()

virtual void geos::FluxApproximationBase::computeCellStencil ( MeshLevel mesh) const
protectedpure virtual

Actual computation of the cell-to-cell stencil.

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

◆ computeFractureStencil()

virtual void geos::FluxApproximationBase::computeFractureStencil ( MeshLevel mesh) const
protectedpure virtual

Actual Computation of the fracture related stencils.

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

Compute the stencils within the fracture itself, but between the fracture and the matrix too.

◆ forAllStencils()

template<typename LAMBDA >
void geos::FluxApproximationBase::forAllStencils ( MeshLevel const &  mesh,
LAMBDA &&  lambda 
) const

Call a user-provided function for each stencil.

Template Parameters
LAMBDAThe type of lambda function passed into the parameter list.
Parameters
[in]meshthe mesh level containing the stencils
[in]lambdaThe LAMBDA function

Definition at line 322 of file FluxApproximationBase.hpp.

◆ forStencils()

template<typename TYPE , typename ... TYPES, typename LAMBDA >
void geos::FluxApproximationBase::forStencils ( MeshLevel const &  mesh,
LAMBDA &&  lambda 
) const

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

Template Parameters
TYPEThe type to be passed to forWrappers
TYPESOther types to be passed to forWrappers
LAMBDAThe type of lambda function passed into the parameter list.
Parameters
[in]meshthe mesh level containing the stencils
[in]lambdaThe LAMBDA function

Definition at line 332 of file FluxApproximationBase.hpp.

◆ getCatalog()

static CatalogInterface::CatalogType& geos::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 & geos::FluxApproximationBase::getStencil ( MeshLevel mesh,
string const &  name 
) const

Extract stencil stored under the mesh group.

Template Parameters
TYPEtype of Stencil to get
Parameters
meshthe mesh level object
namename of the stencil object
Returns
reference to the stencil

Definition at line 315 of file FluxApproximationBase.hpp.

◆ getStencil() [2/2]

template<typename TYPE >
TYPE const & geos::FluxApproximationBase::getStencil ( MeshLevel const &  mesh,
string const &  name 
) const

Extract stencil stored under the mesh group.

Template Parameters
TYPEtype of Stencil to get
Parameters
meshthe mesh level object
namename of the stencil object
Returns
reference to the stencil

Definition at line 308 of file FluxApproximationBase.hpp.

◆ registerAquiferStencil()

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

Register the wrapper for aquifer stencil on a mesh.

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

◆ registerBoundaryStencil()

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

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)

◆ registerCellStencil()

virtual void geos::FluxApproximationBase::registerCellStencil ( Group stencilGroup) const
protectedpure virtual

Register the wrapper for cell stencil on a mesh.

Parameters
stencilGroupthe group holding the stencil objects

◆ registerFractureStencil()

virtual void geos::FluxApproximationBase::registerFractureStencil ( Group stencilGroup) const
protectedpure virtual

Register the wrapper for fracture stencil on a mesh.

Parameters
stencilGroupthe group holding the stencil objects

◆ setCoeffName()

void geos::FluxApproximationBase::setCoeffName ( string const &  name)

set the name of the coefficient.

Parameters
namename of the coefficient.

◆ targetRegions()

array1d< string >& geos::FluxApproximationBase::targetRegions ( string const &  meshBodyName)
inline

get the list of the target regions on a given mesh body.

Parameters
[in]meshBodyNamename of the meshBody
Returns
a list of the target regions on the meshBody

Definition at line 199 of file FluxApproximationBase.hpp.

◆ upwindingParams()

UpwindingParameters const& geos::FluxApproximationBase::upwindingParams ( ) const
inline

get the upwinding parameters.

Returns
upwinding parameters structure.

Definition at line 217 of file FluxApproximationBase.hpp.


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