GEOSX
Public Member Functions | List of all members
geos::finiteElement::KernelFactory< KERNEL_TYPE, ARGS > Class Template Reference

Used to forward arguments to a class that implements the KernelBase interface. More...

#include <KernelBase.hpp>

Public Member Functions

 KernelFactory (ARGS ... args)
 Initialize the factory. More...
 
template<typename SUBREGION_TYPE , typename CONSTITUTIVE_TYPE , typename FE_TYPE >
KERNEL_TYPE< SUBREGION_TYPE, CONSTITUTIVE_TYPE, FE_TYPE > createKernel (NodeManager &nodeManager, EdgeManager const &edgeManager, FaceManager const &faceManager, localIndex const targetRegionIndex, SUBREGION_TYPE const &elementSubRegion, FE_TYPE const &finiteElementSpace, CONSTITUTIVE_TYPE &inputConstitutiveType)
 Create a new kernel with the given standard arguments. More...
 

Detailed Description

template<template< typename SUBREGION_TYPE, typename CONSTITUTIVE_TYPE, typename FE_TYPE > class KERNEL_TYPE, typename ... ARGS>
class geos::finiteElement::KernelFactory< KERNEL_TYPE, ARGS >

Used to forward arguments to a class that implements the KernelBase interface.

Template Parameters
KERNEL_TYPEThe template class to construct, should implement the KernelBase interface.
ARGSThe arguments used to construct a KERNEL_TYPE in addition to the standard arguments.

Definition at line 280 of file KernelBase.hpp.

Constructor & Destructor Documentation

◆ KernelFactory()

template<template< typename SUBREGION_TYPE, typename CONSTITUTIVE_TYPE, typename FE_TYPE > class KERNEL_TYPE, typename ... ARGS>
geos::finiteElement::KernelFactory< KERNEL_TYPE, ARGS >::KernelFactory ( ARGS ...  args)
inline

Initialize the factory.

Parameters
argsThe arguments used to construct a KERNEL_TYPE in addition to the standard arguments.

Definition at line 288 of file KernelBase.hpp.

Member Function Documentation

◆ createKernel()

template<template< typename SUBREGION_TYPE, typename CONSTITUTIVE_TYPE, typename FE_TYPE > class KERNEL_TYPE, typename ... ARGS>
template<typename SUBREGION_TYPE , typename CONSTITUTIVE_TYPE , typename FE_TYPE >
KERNEL_TYPE< SUBREGION_TYPE, CONSTITUTIVE_TYPE, FE_TYPE > geos::finiteElement::KernelFactory< KERNEL_TYPE, ARGS >::createKernel ( NodeManager nodeManager,
EdgeManager const &  edgeManager,
FaceManager const &  faceManager,
localIndex const  targetRegionIndex,
SUBREGION_TYPE const &  elementSubRegion,
FE_TYPE const &  finiteElementSpace,
CONSTITUTIVE_TYPE &  inputConstitutiveType 
)
inline

Create a new kernel with the given standard arguments.

Template Parameters
SUBREGION_TYPEThe type of elementSubRegion.
CONSTITUTIVE_TYPEThe type of inputConstitutiveType.
FE_TYPEThe type of finiteElementSpace.
Parameters
nodeManagerThe node manager.
edgeManagerThe edge manager.
faceManagerThe face manager.
targetRegionIndexThe target region index.
elementSubRegionThe subregion to execute on.
finiteElementSpaceThe finite element space.
inputConstitutiveTypeThe constitutive relation.
Returns
A new kernel constructed with the given arguments and ARGS.

Definition at line 307 of file KernelBase.hpp.


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