Define the base interface for implicit finite element kernels. More...

#include <SparsityKernelBase.hpp>

Inheritance diagram for geos::finiteElement::SparsityKernelBase< SUBREGION_TYPE, CONSTITUTIVE_TYPE, FE_TYPE, NUM_DOF_PER_TEST_SP, NUM_DOF_PER_TRIAL_SP >:

[legend]

Public Types
using	Base = ImplicitKernelBase< SUBREGION_TYPE, CONSTITUTIVE_TYPE, FE_TYPE, NUM_DOF_PER_TEST_SP, NUM_DOF_PER_TRIAL_SP >
	Alias for the base class. (i.e. geos::finiteElement::ImplicitKernelBase)

Public Types inherited from geos::finiteElement::ImplicitKernelBase< SUBREGION_TYPE, CONSTITUTIVE_TYPE, FE_TYPE, NUM_DOF_PER_TEST_SP, NUM_DOF_PER_TRIAL_SP >
using	Base = KernelBase< SUBREGION_TYPE, CONSTITUTIVE_TYPE, FE_TYPE, NUM_DOF_PER_TEST_SP, NUM_DOF_PER_TRIAL_SP >
	Alias for the base class. (i.e. geos::finiteElement::KernelBase)

Public Member Functions
	SparsityKernelBase (NodeManager const &nodeManager, EdgeManager const &edgeManager, FaceManager const &faceManager, localIndex const targetRegionIndex, SUBREGION_TYPE const &elementSubRegion, FE_TYPE const &finiteElementSpace, CONSTITUTIVE_TYPE &inputConstitutiveType, arrayView1d< globalIndex const > const &inputDofNumber, globalIndex const rankOffset, real64 const inputDt, SparsityPattern< globalIndex > &inputSparsity)
	Constructor. More...

real64	complete (localIndex const k, StackVariables &stack) const
	Performs the complete phase for the kernel. More...

GEOS_HOST_DEVICE void	setup (localIndex const k, StackVariables &stack) const
	Performs the setup phase for the kernel. More...

Public Member Functions inherited from geos::finiteElement::ImplicitKernelBase< SUBREGION_TYPE, CONSTITUTIVE_TYPE, FE_TYPE, NUM_DOF_PER_TEST_SP, NUM_DOF_PER_TRIAL_SP >
	ImplicitKernelBase (NodeManager const &nodeManager, EdgeManager const &edgeManager, FaceManager const &faceManager, localIndex const targetRegionIndex, SUBREGION_TYPE const &elementSubRegion, FE_TYPE const &finiteElementSpace, CONSTITUTIVE_TYPE &inputConstitutiveType, arrayView1d< globalIndex const > const &inputDofNumber, globalIndex const rankOffset, CRSMatrixView< real64, globalIndex const > const &inputMatrix, arrayView1d< real64 > const &inputRhs, real64 const inputDt)
	Constructor. More...

GEOS_HOST_DEVICE void	setup (localIndex const k, StackVariables &stack) const
	Performs the setup phase for the kernel. More...

Public Member Functions inherited from geos::finiteElement::KernelBase< SUBREGION_TYPE, CONSTITUTIVE_TYPE, FE_TYPE, NUM_DOF_PER_TEST_SP, NUM_DOF_PER_TRIAL_SP >
	KernelBase (SUBREGION_TYPE const &elementSubRegion, FE_TYPE const &finiteElementSpace, CONSTITUTIVE_TYPE &inputConstitutiveType)
	Constructor. More...

GEOS_HOST_DEVICE void	setup (localIndex const k, StackVariables &stack) const
	Performs the setup phase for the kernel. More...

GEOS_HOST_DEVICE GEOS_FORCE_INLINE void	quadraturePointKernel (localIndex const k, localIndex const q, StackVariables &stack) const
	Performs a state update at a quadrature point. More...

GEOS_HOST_DEVICE real64	complete (localIndex const k, StackVariables &stack) const
	Performs the complete phase for the kernel. More...

Static Public Member Functions
template<typename POLICY , typename KERNEL_TYPE >
static real64	kernelLaunch (localIndex const numElems, KERNEL_TYPE const &kernelComponent)
	Kernel Launcher. More...

Static Public Member Functions inherited from geos::finiteElement::KernelBase< SUBREGION_TYPE, CONSTITUTIVE_TYPE, FE_TYPE, NUM_DOF_PER_TEST_SP, NUM_DOF_PER_TRIAL_SP >
template<typename POLICY , typename KERNEL_TYPE >
static real64	kernelLaunch (localIndex const numElems, KERNEL_TYPE const &kernelComponent)
	Kernel Launcher. More...

Additional Inherited Members
Public Attributes inherited from geos::finiteElement::ImplicitKernelBase< SUBREGION_TYPE, CONSTITUTIVE_TYPE, FE_TYPE, NUM_DOF_PER_TEST_SP, NUM_DOF_PER_TRIAL_SP >
const traits::ViewTypeConst< typename SUBREGION_TYPE::NodeMapType::base_type >	m_elemsToNodes
	The element to nodes map.

const FE_TYPE &	m_finiteElementSpace

Static Public Attributes inherited from geos::finiteElement::ImplicitKernelBase< SUBREGION_TYPE, CONSTITUTIVE_TYPE, FE_TYPE, NUM_DOF_PER_TEST_SP, NUM_DOF_PER_TRIAL_SP >
static constexpr int	maxNumTestSupportPointsPerElem

static constexpr int	maxNumTrialSupportPointsPerElem

static constexpr int	numDofPerTestSupportPoint

static constexpr int	numDofPerTrialSupportPoint

Static Public Attributes inherited from geos::finiteElement::KernelBase< SUBREGION_TYPE, CONSTITUTIVE_TYPE, FE_TYPE, NUM_DOF_PER_TEST_SP, NUM_DOF_PER_TRIAL_SP >
static constexpr int	maxNumTestSupportPointsPerElem = FE_TYPE::maxSupportPoints

static constexpr int	maxNumTrialSupportPointsPerElem = FE_TYPE::maxSupportPoints

static constexpr int	numDofPerTestSupportPoint = NUM_DOF_PER_TEST_SP

static constexpr int	numDofPerTrialSupportPoint = NUM_DOF_PER_TRIAL_SP

static constexpr int	numQuadraturePointsPerElem = FE_TYPE::numQuadraturePoints
	Compile time value for the number of quadrature points per element.

Protected Attributes inherited from geos::finiteElement::ImplicitKernelBase< SUBREGION_TYPE, CONSTITUTIVE_TYPE, FE_TYPE, NUM_DOF_PER_TEST_SP, NUM_DOF_PER_TRIAL_SP >
const arrayView1d< globalIndex const >	m_dofNumber
	The global degree of freedom number.

const globalIndex	m_dofRankOffset
	The global rank offset.

const CRSMatrixView< real64, globalIndex const >	m_matrix
	The global Jacobian matrix.

const arrayView1d< real64 >	m_rhs
	The global residaul vector.

FE_TYPE::template MeshData< SUBREGION_TYPE >	m_meshData
	Data structure containing mesh data used to setup the finite element.

const real64	m_dt
	time increment

Protected Attributes inherited from geos::finiteElement::KernelBase< SUBREGION_TYPE, CONSTITUTIVE_TYPE, FE_TYPE, NUM_DOF_PER_TEST_SP, NUM_DOF_PER_TRIAL_SP >
const traits::ViewTypeConst< typename SUBREGION_TYPE::NodeMapType::base_type >	m_elemsToNodes
	The element to nodes map.

const arrayView1d< integer const >	m_elemGhostRank
	The element ghost rank array.

const CONSTITUTIVE_TYPE::KernelWrapper	m_constitutiveUpdate

const FE_TYPE &	m_finiteElementSpace

Detailed Description

template<typename SUBREGION_TYPE, typename CONSTITUTIVE_TYPE, typename FE_TYPE, int NUM_DOF_PER_TEST_SP, int NUM_DOF_PER_TRIAL_SP>
class geos::finiteElement::SparsityKernelBase< SUBREGION_TYPE, CONSTITUTIVE_TYPE, FE_TYPE, NUM_DOF_PER_TEST_SP, NUM_DOF_PER_TRIAL_SP >

Define the base interface for implicit finite element kernels.

Define the base interface for finite element kernels.

Template Parameters

SUBREGION_TYPE	The type of subregion that the kernel will act on.
CONSTITUTIVE_TYPE	The type of constitutive model present in the subregion.
NUM_TEST_SUPPORT_POINTS_PER_ELEM	The number of test space support points per element.
NUM_TRIAL_SUPPORT_POINTS_PER_ELEM	The number of trial space support points per element.
NUM_DOF_PER_TEST_SP	The number of DOF per test support point.
NUM_DOF_PER_TRIAL_SP	The number of DOF per trial support point.

General KernelBase Description

KernelBase defines an interface for implementing finite element kernels that will be callable by the family of kernel launch functions. Specific physics kernels may or may not derive from KernelBase, but must follow the same interface in order to be callable from the generic launching functions.

The template parameters of KernelBase should be duplicated as part of the interface, EXCEPT for NUM_DOF_PER_TEST_SP and NUM_DOF_PER_TRIAL_SP. These values should be set internally by the physics solver since each physics discretization will have a constant intrinsic value for these quantities. For example, when solving or the heat equation with scalar temperature as the primary variable at the support point, these will have a value of 1. In contrast, when solving a solid mechanics problem, with vector displacement as the primary variable at the support point, these will have a value of 3. Note that the interface provided by geos::finiteElement::RegionBasedKernelApplication will construct a kernel assuming only the first 4 template arguments.

SparsityKernelBase Description

Provide common kernels for generation of CRS Sparsity patterns.

Definition at line 48 of file SparsityKernelBase.hpp.

Constructor & Destructor Documentation

◆ SparsityKernelBase()

template<typename SUBREGION_TYPE , typename CONSTITUTIVE_TYPE , typename FE_TYPE , int NUM_DOF_PER_TEST_SP, int NUM_DOF_PER_TRIAL_SP>

geos::finiteElement::SparsityKernelBase< SUBREGION_TYPE, CONSTITUTIVE_TYPE, FE_TYPE, NUM_DOF_PER_TEST_SP, NUM_DOF_PER_TRIAL_SP >::SparsityKernelBase	(	NodeManager const &	nodeManager,
		EdgeManager const &	edgeManager,
		FaceManager const &	faceManager,
		localIndex const	targetRegionIndex,
		SUBREGION_TYPE const &	elementSubRegion,
		FE_TYPE const &	finiteElementSpace,
		CONSTITUTIVE_TYPE &	inputConstitutiveType,
		arrayView1d< globalIndex const > const &	inputDofNumber,
		globalIndex const	rankOffset,
		real64 const	inputDt,
		SparsityPattern< globalIndex > &	inputSparsity
	)

inline

Constructor.

Parameters

nodeManager	Reference to the NodeManager object.
edgeManager	Reference to the EdgeManager object.
faceManager	Reference to the FaceManager object.
targetRegionIndex	Index of the region the subregion belongs to.
inputDofNumber	The dof number for the primary field.
rankOffset	dof index offset of current rank
inputSparsity	The sparsity pattern to fill.
inputDt	The timestep for the physics update.

Constructor.

Parameters

elementSubRegion	Reference to the SUBREGION_TYPE(class template parameter) object.
inputConstitutiveType	The constitutive object.
finiteElementSpace	Placeholder for the finite element space object, which currently doesn't do much.

Definition at line 81 of file SparsityKernelBase.hpp.

Member Function Documentation

◆ complete()

template<typename SUBREGION_TYPE , typename CONSTITUTIVE_TYPE , typename FE_TYPE , int NUM_DOF_PER_TEST_SP, int NUM_DOF_PER_TRIAL_SP>

real64 geos::finiteElement::SparsityKernelBase< SUBREGION_TYPE, CONSTITUTIVE_TYPE, FE_TYPE, NUM_DOF_PER_TEST_SP, NUM_DOF_PER_TRIAL_SP >::complete	(	localIndex const	k,
		StackVariables &	stack
	)		const

inline

Performs the complete phase for the kernel.

Template Parameters

STACK_VARIABLE_TYPE The type of StackVariable that holds the stack variables. This is most likely a defined in a type that derives from KernelBase.

Parameters

k	The element index.
stack	The StackVariable object that hold the stack variables.

Returns: The maximum contribution to the residual.

KernelBase::complete() Description

The operations typically found in complete are the mapping of the local Jacobian and Residual into the global Jacobian and Residual.

In this implementation, only the matrix values are inserted, making this implementation appropriate for generating the sparsity pattern.

Definition at line 115 of file SparsityKernelBase.hpp.

◆ kernelLaunch()

template<typename SUBREGION_TYPE , typename CONSTITUTIVE_TYPE , typename FE_TYPE , int NUM_DOF_PER_TEST_SP, int NUM_DOF_PER_TRIAL_SP>

template<typename POLICY , typename KERNEL_TYPE >

static real64 geos::finiteElement::SparsityKernelBase< SUBREGION_TYPE, CONSTITUTIVE_TYPE, FE_TYPE, NUM_DOF_PER_TEST_SP, NUM_DOF_PER_TRIAL_SP >::kernelLaunch	(	localIndex const	numElems,
		KERNEL_TYPE const &	kernelComponent
	)

inlinestatic

Kernel Launcher.

Template Parameters

POLICY	The RAJA policy to use for the launch.
NUM_QUADRATURE_POINTS	The number of quadrature points per element.
KERNEL_TYPE	The type of Kernel to execute.

Parameters

numElems	The number of elements to process in this launch.
kernelComponent	The instantiation of KERNEL_TYPE to execute.

Returns: The maximum residual.

This is a generic launching function for all of the finite element kernels that follow the interface set by KernelBase.

Definition at line 151 of file SparsityKernelBase.hpp.

◆ setup()

template<typename SUBREGION_TYPE , typename CONSTITUTIVE_TYPE , typename FE_TYPE , int NUM_DOF_PER_TEST_SP, int NUM_DOF_PER_TRIAL_SP>

GEOS_HOST_DEVICE void geos::finiteElement::KernelBase< SUBREGION_TYPE, CONSTITUTIVE_TYPE, FE_TYPE, NUM_DOF_PER_TEST_SP, NUM_DOF_PER_TRIAL_SP >::setup

inline

Performs the setup phase for the kernel.

Template Parameters

STACK_VARIABLE_TYPE The type of StackVariable that holds the stack variables. This is most likely a defined in a type that derives from KernelBase.

Parameters

k	The element index.
stack	The StackVariable object that hold the stack variables.

KernelBase::setup() Description

The operations typically found in setup are thing such as the collection of global data into local stack storage.

Definition at line 153 of file KernelBase.hpp.

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

coreComponents/finiteElement/kernelInterface/SparsityKernelBase.hpp

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

template<typename SUBREGION_TYPE, typename CONSTITUTIVE_TYPE, typename FE_TYPE, int NUM_DOF_PER_TEST_SP, int NUM_DOF_PER_TRIAL_SP> class geos::finiteElement::SparsityKernelBase< SUBREGION_TYPE, CONSTITUTIVE_TYPE, FE_TYPE, NUM_DOF_PER_TEST_SP, NUM_DOF_PER_TRIAL_SP >

General KernelBase Description

SparsityKernelBase Description

Constructor & Destructor Documentation

◆ SparsityKernelBase()

Member Function Documentation

◆ complete()

KernelBase::complete() Description

◆ kernelLaunch()

◆ setup()

KernelBase::setup() Description

template<typename SUBREGION_TYPE, typename CONSTITUTIVE_TYPE, typename FE_TYPE, int NUM_DOF_PER_TEST_SP, int NUM_DOF_PER_TRIAL_SP>
class geos::finiteElement::SparsityKernelBase< SUBREGION_TYPE, CONSTITUTIVE_TYPE, FE_TYPE, NUM_DOF_PER_TEST_SP, NUM_DOF_PER_TRIAL_SP >