geos::TractionBoundaryCondition Class Reference

#include <TractionBoundaryCondition.hpp>

Inheritance diagram for geos::TractionBoundaryCondition:

Classes
struct	viewKeyStruct
	View keys. More...

Public Types
enum class	TractionType : integer { vector , normal , stress }
	Type of traction boundary condition. More...
Public Types inherited from geos::FieldSpecificationBase
using	CatalogInterface = dataRepository::CatalogInterface< FieldSpecificationBase, string const &, dataRepository::Group *const >
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
	TractionBoundaryCondition (string const &name, Group *parent)
	constructor More...
	TractionBoundaryCondition ()=delete
	deleted default constructor
virtual	~TractionBoundaryCondition ()=default
	default destructor
	TractionBoundaryCondition (TractionBoundaryCondition const &)=delete
	deleted copy constructor
	TractionBoundaryCondition (TractionBoundaryCondition &&)=default
	defaulted move constructor
TractionBoundaryCondition &	operator= (TractionBoundaryCondition const &)=delete
	deleted copy assignment operator
TractionBoundaryCondition &	operator= (TractionBoundaryCondition &&)=delete
	deleted move assignment operator
void	launch (real64 const time, arrayView1d< globalIndex const > const blockLocalDofNumber, globalIndex const dofRankOffset, FaceManager const &faceManager, SortedArrayView< localIndex const > const &targetSet, arrayView1d< real64 > const &localRhs) const
	Setup and Launche of the traction BC kernel. More...
Public Member Functions inherited from geos::FieldSpecificationBase
virtual const string	getCatalogName () const
	return the catalog name More...
	FieldSpecificationBase (string const &name, dataRepository::Group *parent)
	constructor More...
virtual	~FieldSpecificationBase () override
	FieldSpecificationBase (FieldSpecificationBase const &)=delete
	Deleted copy constructor.
	FieldSpecificationBase (FieldSpecificationBase &&)=default
	Defaulted move constructor.
FieldSpecificationBase &	operator= (FieldSpecificationBase const &)=delete
	deleted copy assignment
FieldSpecificationBase &	operator= (FieldSpecificationBase &&)=delete
	deleted move assignement
template<typename OBJECT_TYPE , typename BC_TYPE = FieldSpecificationBase, typename LAMBDA >
void	apply (MeshLevel &mesh, LAMBDA &&lambda) const
	Apply this field specification to the discretization. More...
template<typename FIELD_OP , typename POLICY , typename T , int N, int USD>
void	applyFieldValueKernel (ArrayView< T, N, USD > const &field, SortedArrayView< localIndex const > const &targetSet, real64 const time, Group &dataGroup) const
template<typename FIELD_OP , typename POLICY = parallelHostPolicy>
void	applyFieldValue (SortedArrayView< localIndex const > const &targetSet, real64 const time, dataRepository::Group &dataGroup, string const &fieldname) const
template<typename FIELD_OP , typename POLICY , typename T , int NDIM, int USD>
void	applyBoundaryConditionToSystemKernel (SortedArrayView< localIndex const > const &targetSet, real64 const time, dataRepository::Group const &dataGroup, arrayView1d< globalIndex const > const &dofMap, globalIndex const dofRankOffset, CRSMatrixView< real64, globalIndex const > const &matrix, arrayView1d< real64 > const &rhs, ArrayView< T const, NDIM, USD > const &fieldView) const
	Apply a boundary condition to a system of equations. More...
template<typename FIELD_OP , typename POLICY >
void	applyBoundaryConditionToSystem (SortedArrayView< localIndex const > const &targetSet, real64 const time, dataRepository::Group const &dataGroup, string const &fieldName, string const &dofMapName, globalIndex const dofRankOffset, CRSMatrixView< real64, globalIndex const > const &matrix, arrayView1d< real64 > const &rhs) const
	Apply a boundary condition to a system of equations. More...
template<typename FIELD_OP , typename POLICY , typename LAMBDA >
void	applyBoundaryConditionToSystem (SortedArrayView< localIndex const > const &targetSet, real64 const time, dataRepository::Group const &dataGroup, arrayView1d< globalIndex const > const &dofMap, globalIndex const dofRankOffset, CRSMatrixView< real64, globalIndex const > const &matrix, arrayView1d< real64 > const &rhs, LAMBDA &&lambda) const
	Apply a boundary condition to a system of equations. More...
template<typename FIELD_OP , typename POLICY , typename LAMBDA >
void	applyBoundaryConditionToSystem (SortedArrayView< localIndex const > const &targetSet, real64 const time, real64 const dt, dataRepository::Group const &dataGroup, arrayView1d< globalIndex const > const &dofMap, globalIndex const dofRankOffset, CRSMatrixView< real64, globalIndex const > const &matrix, arrayView1d< real64 > const &rhs, LAMBDA &&lambda) const
	Apply a boundary condition to a system of equations. More...
template<typename FIELD_OP , typename POLICY , typename LAMBDA >
void	computeRhsContribution (SortedArrayView< localIndex const > const &targetSet, real64 const time, real64 const dt, dataRepository::Group const &dataGroup, arrayView1d< globalIndex const > const &dofMap, globalIndex const dofRankOffset, CRSMatrixView< real64, globalIndex const > const &matrix, arrayView1d< globalIndex > const &dof, arrayView1d< real64 > const &rhsContribution, LAMBDA &&lambda) const
	Compute the contributions that will be added/enforced to the right-hand side, and collect the corresponding dof numbers. More...
template<typename POLICY >
void	zeroSystemRowsForBoundaryCondition (SortedArrayView< localIndex const > const &targetSet, arrayView1d< globalIndex const > const &dofMap, CRSMatrixView< real64, globalIndex const > const &matrix) const
	Function to zero matrix rows to apply boundary conditions. More...
string const &	getFunctionName () const
virtual const string &	getObjectPath () const
virtual const string &	getFieldName () const
virtual int	getComponent () const
virtual R1Tensor const &	getDirection () const
real64	getStartTime () const
real64	getEndTime () const
string_array const &	getSetNames () const
int	initialCondition () const
real64	getScale () const
void	setFieldName (string const &fieldName)
void	setObjectPath (string const &objectPath)
void	setScale (real64 const &scale)
void	initialCondition (bool isInitialCondition)
void	addSetName (string const &setName)
void	setMeshObjectPath (Group const &meshBodies)
	Set the Mesh Object Path object. More...
MeshObjectPath const &	getMeshObjectPaths () const
	Get the Mesh Object Paths object. 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.
Group &	operator= (Group const &)=delete
	Deleted copy assignment operator. More...
Group &	operator= (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 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...
std::vector< string >	getSubGroupsNames () 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...
WrapperBase &	registerWrapper (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 >
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...
std::vector< string >	getWrappersNames () 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
Group &	getParent ()
	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...
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 ()
void	setLogLevel (integer const logLevel)
	Set verbosity level. More...
integer	getLogLevel () const

Static Public Member Functions
static string	catalogName ()
	Static Factory Catalog Functions. More...
Static Public Member Functions inherited from geos::FieldSpecificationBase
static CatalogInterface::CatalogType &	getCatalog ()
	static function to return static catalog. More...
static string	catalogName ()
	Static Factory Catalog Functions. 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::CatalogType &	getCatalog ()
	Get the singleton catalog for this Group. More...

Protected Member Functions
virtual void	postInputInitialization () override final
virtual void	initializePreSubGroups () override final
	Called by Initialize() prior to initializing sub-Groups.
Protected Member Functions inherited from geos::dataRepository::Group
virtual void	initializePostSubGroups ()
	Called by Initialize() after to initializing sub-Groups.
virtual void	initializePostInitialConditionsPreSubGroups ()
	Called by InitializePostInitialConditions() prior 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
TractionType	m_tractionType
	The type of traction to be applied, i.e. how to generate the traction.
R2SymTensor	m_inputStress
	single specified value for stress used to generate the traction if m_tractionType == stress.

Detailed Description

Holds data and methods to apply a traction boundary condition

Definition at line 36 of file TractionBoundaryCondition.hpp.

Member Enumeration Documentation

TractionType

enum geos::TractionBoundaryCondition::TractionType : integer

strong

Type of traction boundary condition.

Enumerator
vector	traction is applied to the faces as specified from the scale and direction
normal	traction is applied to the faces as a pressure specified from the product of scale and the outward face normal
stress	traction is applied to the faces as specified by the inner product of input stress and face normal

Definition at line 103 of file TractionBoundaryCondition.hpp.

Constructor & Destructor Documentation

TractionBoundaryCondition()

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

constructor

Parameters

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

Member Function Documentation

catalogName()

static string geos::TractionBoundaryCondition::catalogName ( )

inlinestatic

Static Factory Catalog Functions.

Returns

the catalog name

Definition at line 65 of file TractionBoundaryCondition.hpp.

launch()

void geos::TractionBoundaryCondition::launch	(	real64 const	time,
		arrayView1d< globalIndex const > const	blockLocalDofNumber,
		globalIndex const	dofRankOffset,
		FaceManager const &	faceManager,
		SortedArrayView< localIndex const > const &	targetSet,
		arrayView1d< real64 > const &	localRhs
	)		const

Setup and Launche of the traction BC kernel.

Parameters

time	The time that should be used to evaluate any time tables.
blockLocalDofNumber	Array of block local DOF numbers for the displacement.
dofRankOffset	The rank offset for the DOF.
faceManager	Reference to the face manager (Tractions are applied on faces)
targetSet	The set of faces to apply the BC to.
localRhs	The RHS of the system to add contributions to.

postInputInitialization()

virtual void geos::TractionBoundaryCondition::postInputInitialization ( )

finaloverrideprotectedvirtual

This function provides capability to post process input values prior to any other initialization operations.

Reimplemented from geos::dataRepository::Group.

---

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

• coreComponents/fieldSpecification/TractionBoundaryCondition.hpp