version 3.9-dev
Dumux::Experimental::CVFELocalAssemblerBase< TypeTag, Assembler, Implementation > Class Template Reference

A base class for all local CVFE assemblers. More...

#include <dumux/experimental/assembly/cvfelocalassembler.hh>

Inheritance diagram for Dumux::Experimental::CVFELocalAssemblerBase< TypeTag, Assembler, Implementation >:

Description

template<class TypeTag, class Assembler, class Implementation>
class Dumux::Experimental::CVFELocalAssemblerBase< TypeTag, Assembler, Implementation >
Template Parameters
TypeTagThe TypeTag
AssemblerThe assembler type
ImplementationThe actual implementation

Public Types

using LocalResidual = typename ParentType::LocalResidual
 
using ElementResidualVector = typename LocalResidual::ElementResidualVector
 

Public Member Functions

void bindLocalViews ()
 
template<class ResidualVector , class StageParams , class PartialReassembler = DefaultPartialReassembler, class CouplingFunction = Noop>
void assembleJacobianAndResidual (JacobianMatrix &jac, ResidualVector &res, GridVariables &gridVariables, const StageParams &stageParams, ResidualVector &temporal, ResidualVector &spatial, ResidualVector &constrainedDofs, const PartialReassembler *partialReassembler=nullptr, const CouplingFunction &maybeAssembleCouplingBlocks=noop)
 Computes the derivatives with respect to the given element and adds them to the global matrix. The element residual is written into the right hand side. More...
 
void assembleJacobian (JacobianMatrix &jac, GridVariables &gridVariables)
 Computes the derivatives with respect to the given element and adds them to the global matrix. More...
 
template<class ResidualVector >
void assembleResidual (ResidualVector &res)
 Assemble the residual only. More...
 
template<class ResidualVector >
void assembleCurrentResidual (ResidualVector &spatialRes, ResidualVector &temporalRes)
 Assemble the residual only. More...
 
template<typename ApplyFunction >
void enforceDirichletConstraints (const ApplyFunction &applyDirichlet)
 Enforce Dirichlet constraints. More...
 
template<typename ApplyDirichletFunctionType >
void evalDirichletBoundaries (ApplyDirichletFunctionType applyDirichlet)
 Evaluates Dirichlet boundaries. More...
 
template<class... Args>
void maybeUpdateCouplingContext (Args &&...)
 Update the coupling context for coupled models. More...
 
template<class... Args>
void maybeEvalAdditionalDomainDerivatives (Args &&...)
 Update the additional domain derivatives for coupled models. More...
 
ElementResidualVector evalLocalResidual () const
 Convenience function to evaluate the complete local residual for the current element. Automatically chooses the the appropriate element volume variables. More...
 
ElementResidualVector evalLocalResidual (const ElementVolumeVariables &elemVolVars) const
 Evaluates the complete local residual for the current element. More...
 
ElementResidualVector evalLocalFluxAndSourceResidual () const
 Convenience function to evaluate the flux and source terms (i.e, the terms without a time derivative) of the local residual for the current element. Automatically chooses the the appropriate element volume variables. More...
 
ElementResidualVector evalLocalFluxAndSourceResidual (const ElementVolumeVariables &elemVolVars) const
 Evaluates the flux and source terms (i.e, the terms without a time derivative) of the local residual for the current element. More...
 
ElementResidualVector evalStorage () const
 Convenience function to evaluate storage term (i.e, the term with a time derivative) of the local residual for the current element. Automatically chooses the the appropriate element volume variables. More...
 
template<typename ApplyFunction , class P = Problem, typename std::enable_if_t< P::enableInternalDirichletConstraints(), int > = 0>
void enforceInternalDirichletConstraints (const ApplyFunction &applyDirichlet)
 Enforces Dirichlet constraints if enabled in the problem. More...
 
template<typename ApplyFunction , class P = Problem, typename std::enable_if_t<!P::enableInternalDirichletConstraints(), int > = 0>
void enforceInternalDirichletConstraints (const ApplyFunction &applyDirichlet)
 
const Problem & problem () const
 The problem. More...
 
const Assembler & assembler () const
 The assembler. More...
 
const Element & element () const
 The current element. More...
 
bool elementIsGhost () const
 Returns if element is a ghost entity. More...
 
const SolutionVector & curSol () const
 The current solution. More...
 
FVElementGeometry & fvGeometry ()
 The global finite volume geometry. More...
 
const FVElementGeometry & fvGeometry () const
 The finite volume geometry. More...
 
ElementVolumeVariables & curElemVolVars ()
 The current element volume variables. More...
 
const ElementVolumeVariables & curElemVolVars () const
 The current element volume variables. More...
 
ElementFluxVariablesCache & elemFluxVarsCache ()
 The element flux variables cache. More...
 
const ElementFluxVariablesCache & elemFluxVarsCache () const
 The element flux variables cache. More...
 
LocalResiduallocalResidual ()
 The local residual for the current element. More...
 
const LocalResiduallocalResidual () const
 The local residual for the current element. More...
 
ElementBoundaryTypes & elemBcTypes ()
 The element's boundary types. More...
 
const ElementBoundaryTypes & elemBcTypes () const
 The element's boundary types. More...
 
bool isImplicit () const
 If the time stepping scheme is implicit. More...
 

Protected Member Functions

Implementation & asImp_ ()
 
const Implementation & asImp_ () const
 
template<class T = TypeTag, typename std::enable_if_t<!GetPropType< T, Properties::GridVariables >::GridVolumeVariables::cachingEnabled, int > = 0>
VolumeVariables & getVolVarAccess (GridVolumeVariables &gridVolVars, ElementVolumeVariables &elemVolVars, const SubControlVolume &scv)
 
template<class T = TypeTag, typename std::enable_if_t< GetPropType< T, Properties::GridVariables >::GridVolumeVariables::cachingEnabled, int > = 0>
VolumeVariables & getVolVarAccess (GridVolumeVariables &gridVolVars, ElementVolumeVariables &elemVolVars, const SubControlVolume &scv)
 

Member Typedef Documentation

◆ ElementResidualVector

template<class TypeTag , class Assembler , class Implementation >
using Dumux::Experimental::CVFELocalAssemblerBase< TypeTag, Assembler, Implementation >::ElementResidualVector = typename LocalResidual::ElementResidualVector

◆ LocalResidual

template<class TypeTag , class Assembler , class Implementation >
using Dumux::Experimental::CVFELocalAssemblerBase< TypeTag, Assembler, Implementation >::LocalResidual = typename ParentType::LocalResidual

Member Function Documentation

◆ asImp_() [1/2]

template<class TypeTag , class Assembler , class Implementation >
Implementation & Dumux::Experimental::FVLocalAssemblerBase< TypeTag, Assembler, Implementation >::asImp_ ( )
inlineprotectedinherited

◆ asImp_() [2/2]

template<class TypeTag , class Assembler , class Implementation >
const Implementation & Dumux::Experimental::FVLocalAssemblerBase< TypeTag, Assembler, Implementation >::asImp_ ( ) const
inlineprotectedinherited

◆ assembleCurrentResidual()

template<class TypeTag , class Assembler , class Implementation >
template<class ResidualVector >
void Dumux::Experimental::CVFELocalAssemblerBase< TypeTag, Assembler, Implementation >::assembleCurrentResidual ( ResidualVector &  spatialRes,
ResidualVector &  temporalRes 
)
inline

◆ assembleJacobian()

template<class TypeTag , class Assembler , class Implementation >
void Dumux::Experimental::CVFELocalAssemblerBase< TypeTag, Assembler, Implementation >::assembleJacobian ( JacobianMatrix &  jac,
GridVariables &  gridVariables 
)
inline

◆ assembleJacobianAndResidual()

template<class TypeTag , class Assembler , class Implementation >
template<class ResidualVector , class StageParams , class PartialReassembler = DefaultPartialReassembler, class CouplingFunction = Noop>
void Dumux::Experimental::CVFELocalAssemblerBase< TypeTag, Assembler, Implementation >::assembleJacobianAndResidual ( JacobianMatrix &  jac,
ResidualVector &  res,
GridVariables &  gridVariables,
const StageParams &  stageParams,
ResidualVector &  temporal,
ResidualVector &  spatial,
ResidualVector &  constrainedDofs,
const PartialReassembler partialReassembler = nullptr,
const CouplingFunction &  maybeAssembleCouplingBlocks = noop 
)
inline

◆ assembler()

template<class TypeTag , class Assembler , class Implementation >
const Assembler & Dumux::Experimental::FVLocalAssemblerBase< TypeTag, Assembler, Implementation >::assembler ( ) const
inlineinherited

◆ assembleResidual()

template<class TypeTag , class Assembler , class Implementation >
template<class ResidualVector >
void Dumux::Experimental::CVFELocalAssemblerBase< TypeTag, Assembler, Implementation >::assembleResidual ( ResidualVector &  res)
inline

◆ bindLocalViews()

template<class TypeTag , class Assembler , class Implementation >
void Dumux::Experimental::CVFELocalAssemblerBase< TypeTag, Assembler, Implementation >::bindLocalViews ( )
inline

◆ curElemVolVars() [1/2]

template<class TypeTag , class Assembler , class Implementation >
ElementVolumeVariables & Dumux::Experimental::FVLocalAssemblerBase< TypeTag, Assembler, Implementation >::curElemVolVars ( )
inlineinherited

◆ curElemVolVars() [2/2]

template<class TypeTag , class Assembler , class Implementation >
const ElementVolumeVariables & Dumux::Experimental::FVLocalAssemblerBase< TypeTag, Assembler, Implementation >::curElemVolVars ( ) const
inlineinherited

◆ curSol()

template<class TypeTag , class Assembler , class Implementation >
const SolutionVector & Dumux::Experimental::FVLocalAssemblerBase< TypeTag, Assembler, Implementation >::curSol ( ) const
inlineinherited

◆ elemBcTypes() [1/2]

template<class TypeTag , class Assembler , class Implementation >
ElementBoundaryTypes & Dumux::Experimental::FVLocalAssemblerBase< TypeTag, Assembler, Implementation >::elemBcTypes ( )
inlineinherited

◆ elemBcTypes() [2/2]

template<class TypeTag , class Assembler , class Implementation >
const ElementBoundaryTypes & Dumux::Experimental::FVLocalAssemblerBase< TypeTag, Assembler, Implementation >::elemBcTypes ( ) const
inlineinherited

◆ element()

template<class TypeTag , class Assembler , class Implementation >
const Element & Dumux::Experimental::FVLocalAssemblerBase< TypeTag, Assembler, Implementation >::element ( ) const
inlineinherited

◆ elementIsGhost()

template<class TypeTag , class Assembler , class Implementation >
bool Dumux::Experimental::FVLocalAssemblerBase< TypeTag, Assembler, Implementation >::elementIsGhost ( ) const
inlineinherited

◆ elemFluxVarsCache() [1/2]

template<class TypeTag , class Assembler , class Implementation >
ElementFluxVariablesCache & Dumux::Experimental::FVLocalAssemblerBase< TypeTag, Assembler, Implementation >::elemFluxVarsCache ( )
inlineinherited

◆ elemFluxVarsCache() [2/2]

template<class TypeTag , class Assembler , class Implementation >
const ElementFluxVariablesCache & Dumux::Experimental::FVLocalAssemblerBase< TypeTag, Assembler, Implementation >::elemFluxVarsCache ( ) const
inlineinherited

◆ enforceDirichletConstraints()

template<class TypeTag , class Assembler , class Implementation >
template<typename ApplyFunction >
void Dumux::Experimental::CVFELocalAssemblerBase< TypeTag, Assembler, Implementation >::enforceDirichletConstraints ( const ApplyFunction &  applyDirichlet)
inline

◆ enforceInternalDirichletConstraints() [1/2]

template<class TypeTag , class Assembler , class Implementation >
template<typename ApplyFunction , class P = Problem, typename std::enable_if_t< P::enableInternalDirichletConstraints(), int > = 0>
void Dumux::Experimental::FVLocalAssemblerBase< TypeTag, Assembler, Implementation >::enforceInternalDirichletConstraints ( const ApplyFunction &  applyDirichlet)
inlineinherited

◆ enforceInternalDirichletConstraints() [2/2]

template<class TypeTag , class Assembler , class Implementation >
template<typename ApplyFunction , class P = Problem, typename std::enable_if_t<!P::enableInternalDirichletConstraints(), int > = 0>
void Dumux::Experimental::FVLocalAssemblerBase< TypeTag, Assembler, Implementation >::enforceInternalDirichletConstraints ( const ApplyFunction &  applyDirichlet)
inlineinherited

◆ evalDirichletBoundaries()

template<class TypeTag , class Assembler , class Implementation >
template<typename ApplyDirichletFunctionType >
void Dumux::Experimental::CVFELocalAssemblerBase< TypeTag, Assembler, Implementation >::evalDirichletBoundaries ( ApplyDirichletFunctionType  applyDirichlet)
inline

◆ evalLocalFluxAndSourceResidual() [1/2]

template<class TypeTag , class Assembler , class Implementation >
ElementResidualVector Dumux::Experimental::FVLocalAssemblerBase< TypeTag, Assembler, Implementation >::evalLocalFluxAndSourceResidual ( ) const
inlineinherited

◆ evalLocalFluxAndSourceResidual() [2/2]

template<class TypeTag , class Assembler , class Implementation >
ElementResidualVector Dumux::Experimental::FVLocalAssemblerBase< TypeTag, Assembler, Implementation >::evalLocalFluxAndSourceResidual ( const ElementVolumeVariables &  elemVolVars) const
inlineinherited
Parameters
elemVolVarsThe element volume variables

◆ evalLocalResidual() [1/2]

template<class TypeTag , class Assembler , class Implementation >
ElementResidualVector Dumux::Experimental::FVLocalAssemblerBase< TypeTag, Assembler, Implementation >::evalLocalResidual ( ) const
inlineinherited

◆ evalLocalResidual() [2/2]

template<class TypeTag , class Assembler , class Implementation >
ElementResidualVector Dumux::Experimental::FVLocalAssemblerBase< TypeTag, Assembler, Implementation >::evalLocalResidual ( const ElementVolumeVariables &  elemVolVars) const
inlineinherited
Parameters
elemVolVarsThe element volume variables

◆ evalStorage()

template<class TypeTag , class Assembler , class Implementation >
ElementResidualVector Dumux::Experimental::FVLocalAssemblerBase< TypeTag, Assembler, Implementation >::evalStorage ( ) const
inlineinherited

◆ fvGeometry() [1/2]

template<class TypeTag , class Assembler , class Implementation >
FVElementGeometry & Dumux::Experimental::FVLocalAssemblerBase< TypeTag, Assembler, Implementation >::fvGeometry ( )
inlineinherited

◆ fvGeometry() [2/2]

template<class TypeTag , class Assembler , class Implementation >
const FVElementGeometry & Dumux::Experimental::FVLocalAssemblerBase< TypeTag, Assembler, Implementation >::fvGeometry ( ) const
inlineinherited

◆ getVolVarAccess() [1/2]

template<class TypeTag , class Assembler , class Implementation >
template<class T = TypeTag, typename std::enable_if_t<!GetPropType< T, Properties::GridVariables >::GridVolumeVariables::cachingEnabled, int > = 0>
VolumeVariables & Dumux::Experimental::FVLocalAssemblerBase< TypeTag, Assembler, Implementation >::getVolVarAccess ( GridVolumeVariables &  gridVolVars,
ElementVolumeVariables &  elemVolVars,
const SubControlVolume &  scv 
)
inlineprotectedinherited

◆ getVolVarAccess() [2/2]

template<class TypeTag , class Assembler , class Implementation >
template<class T = TypeTag, typename std::enable_if_t< GetPropType< T, Properties::GridVariables >::GridVolumeVariables::cachingEnabled, int > = 0>
VolumeVariables & Dumux::Experimental::FVLocalAssemblerBase< TypeTag, Assembler, Implementation >::getVolVarAccess ( GridVolumeVariables &  gridVolVars,
ElementVolumeVariables &  elemVolVars,
const SubControlVolume &  scv 
)
inlineprotectedinherited

◆ isImplicit()

template<class TypeTag , class Assembler , class Implementation >
bool Dumux::Experimental::FVLocalAssemblerBase< TypeTag, Assembler, Implementation >::isImplicit ( ) const
inlineinherited

◆ localResidual() [1/2]

template<class TypeTag , class Assembler , class Implementation >
LocalResidual & Dumux::Experimental::FVLocalAssemblerBase< TypeTag, Assembler, Implementation >::localResidual ( )
inlineinherited

◆ localResidual() [2/2]

template<class TypeTag , class Assembler , class Implementation >
const LocalResidual & Dumux::Experimental::FVLocalAssemblerBase< TypeTag, Assembler, Implementation >::localResidual ( ) const
inlineinherited

◆ maybeEvalAdditionalDomainDerivatives()

template<class TypeTag , class Assembler , class Implementation >
template<class... Args>
void Dumux::Experimental::CVFELocalAssemblerBase< TypeTag, Assembler, Implementation >::maybeEvalAdditionalDomainDerivatives ( Args &&  ...)
inline
Note
This does nothing per default (not a coupled model).

◆ maybeUpdateCouplingContext()

template<class TypeTag , class Assembler , class Implementation >
template<class... Args>
void Dumux::Experimental::CVFELocalAssemblerBase< TypeTag, Assembler, Implementation >::maybeUpdateCouplingContext ( Args &&  ...)
inline
Note
This does nothing per default (not a coupled model).

◆ problem()

template<class TypeTag , class Assembler , class Implementation >
const Problem & Dumux::Experimental::FVLocalAssemblerBase< TypeTag, Assembler, Implementation >::problem ( ) const
inlineinherited

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