3.5-git
DUNE for Multi-{Phase, Component, Scale, Physics, ...} flow and transport in porous media
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
Dumux::FaceCenteredLocalAssembler< TypeTag, Assembler, DiffMethod::analytic, false > Class Template Reference

TODO docme. More...

#include <dumux/assembly/fclocalassembler.hh>

Inheritance diagram for Dumux::FaceCenteredLocalAssembler< TypeTag, Assembler, DiffMethod::analytic, false >:

Description

template<class TypeTag, class Assembler>
class Dumux::FaceCenteredLocalAssembler< TypeTag, Assembler, DiffMethod::analytic, false >

TODO docme.

Public Member Functions

template<class PartialReassembler = DefaultPartialReassembler>
ElementResidualVector assembleJacobianAndResidualImpl (JacobianMatrix &A, GridVariables &gridVariables, const PartialReassembler *partialReassembler=nullptr)
 Computes the derivatives with respect to the given element and adds them to the global matrix. More...
 
void bindLocalViews ()
 
void assembleJacobianAndResidual (JacobianMatrix &jac, SolutionVector &res, GridVariables &gridVariables, const PartialReassembler *partialReassembler, const CouplingFunction &maybeAssembleCouplingBlocks=CouplingFunction{})
 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...
 
void assembleResidual (SolutionVector &res)
 Assemble the residual only. More...
 
void enforceDirichletConstraints (const ApplyFunction &applyDirichlet)
 Enforce Dirichlet constraints. More...
 
void evalDirichletBoundaries (ApplyDirichletFunctionType applyDirichlet)
 Evaluates Dirichlet boundaries. More...
 
void maybeUpdateCouplingContext (Args &&...)
 Update the coupling context for coupled models. More...
 
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 evalLocalStorageResidual () 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...
 
void enforceInternalDirichletConstraints (const ApplyFunction &applyDirichlet)
 Enforces Dirichlet constraints if enabled in the problem. More...
 
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...
 
ElementVolumeVariables & prevElemVolVars ()
 The element volume variables of the provious time step. More...
 
const ElementVolumeVariables & prevElemVolVars () const
 The element volume variables of the provious time step. More...
 
ElementFluxVariablesCache & elemFluxVarsCache ()
 The element flux variables cache. More...
 
const ElementFluxVariablesCache & elemFluxVarsCache () const
 The element flux variables cache. More...
 
LocalResidual & localResidual ()
 The local residual for the current element. More...
 
const LocalResidual & localResidual () 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...
 

Static Public Member Functions

static constexpr bool isImplicit ()
 Returns true if the assembler considers implicit assembly. More...
 

Protected Member Functions

FaceCenteredLocalAssembler< TypeTag, Assembler, DiffMethod::analytic, false > & asImp_ ()
 
const FaceCenteredLocalAssembler< TypeTag, Assembler, DiffMethod::analytic, false > & asImp_ () const
 
VolumeVariables & getVolVarAccess (GridVolumeVariables &gridVolVars, ElementVolumeVariables &elemVolVars, const SubControlVolume &scv)
 
VolumeVariables & getVolVarAccess (GridVolumeVariables &gridVolVars, ElementVolumeVariables &elemVolVars, const SubControlVolume &scv)
 

Member Function Documentation

◆ asImp_() [1/2]

FaceCenteredLocalAssembler< TypeTag, Assembler, DiffMethod::analytic, false > & Dumux::FVLocalAssemblerBase< TypeTag, Assembler, FaceCenteredLocalAssembler< TypeTag, Assembler, DiffMethod::analytic, false > , useImplicitAssembly >::asImp_ ( )
inlineprotectedinherited

◆ asImp_() [2/2]

const FaceCenteredLocalAssembler< TypeTag, Assembler, DiffMethod::analytic, false > & Dumux::FVLocalAssemblerBase< TypeTag, Assembler, FaceCenteredLocalAssembler< TypeTag, Assembler, DiffMethod::analytic, false > , useImplicitAssembly >::asImp_ ( ) const
inlineprotectedinherited

◆ assembleJacobian()

void Dumux::FaceCenteredLocalAssemblerBase< TypeTag, Assembler, FaceCenteredLocalAssembler< TypeTag, Assembler, DiffMethod::analytic, false > , implicit >::assembleJacobian ( JacobianMatrix &  jac,
GridVariables &  gridVariables 
)
inlineinherited

Computes the derivatives with respect to the given element and adds them to the global matrix.

◆ assembleJacobianAndResidual()

void Dumux::FaceCenteredLocalAssemblerBase< TypeTag, Assembler, FaceCenteredLocalAssembler< TypeTag, Assembler, DiffMethod::analytic, false > , implicit >::assembleJacobianAndResidual ( JacobianMatrix &  jac,
SolutionVector &  res,
GridVariables &  gridVariables,
const PartialReassembler partialReassembler,
const CouplingFunction &  maybeAssembleCouplingBlocks = CouplingFunction{} 
)
inlineinherited

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.

◆ assembleJacobianAndResidualImpl()

template<class TypeTag , class Assembler >
template<class PartialReassembler = DefaultPartialReassembler>
ElementResidualVector Dumux::FaceCenteredLocalAssembler< TypeTag, Assembler, DiffMethod::analytic, false >::assembleJacobianAndResidualImpl ( JacobianMatrix &  A,
GridVariables &  gridVariables,
const PartialReassembler partialReassembler = nullptr 
)
inline

Computes the derivatives with respect to the given element and adds them to the global matrix.

Returns
The element residual at the current solution.

◆ assembler()

const Assembler & Dumux::FVLocalAssemblerBase< TypeTag, Assembler, FaceCenteredLocalAssembler< TypeTag, Assembler, DiffMethod::analytic, false > , useImplicitAssembly >::assembler ( ) const
inlineinherited

The assembler.

◆ assembleResidual()

void Dumux::FaceCenteredLocalAssemblerBase< TypeTag, Assembler, FaceCenteredLocalAssembler< TypeTag, Assembler, DiffMethod::analytic, false > , implicit >::assembleResidual ( SolutionVector &  res)
inlineinherited

Assemble the residual only.

◆ bindLocalViews()

void Dumux::FaceCenteredLocalAssemblerBase< TypeTag, Assembler, FaceCenteredLocalAssembler< TypeTag, Assembler, DiffMethod::analytic, false > , implicit >::bindLocalViews ( )
inlineinherited

◆ curElemVolVars() [1/2]

ElementVolumeVariables & Dumux::FVLocalAssemblerBase< TypeTag, Assembler, FaceCenteredLocalAssembler< TypeTag, Assembler, DiffMethod::analytic, false > , useImplicitAssembly >::curElemVolVars ( )
inlineinherited

The current element volume variables.

◆ curElemVolVars() [2/2]

const ElementVolumeVariables & Dumux::FVLocalAssemblerBase< TypeTag, Assembler, FaceCenteredLocalAssembler< TypeTag, Assembler, DiffMethod::analytic, false > , useImplicitAssembly >::curElemVolVars ( ) const
inlineinherited

The current element volume variables.

◆ curSol()

const SolutionVector & Dumux::FVLocalAssemblerBase< TypeTag, Assembler, FaceCenteredLocalAssembler< TypeTag, Assembler, DiffMethod::analytic, false > , useImplicitAssembly >::curSol ( ) const
inlineinherited

The current solution.

◆ elemBcTypes() [1/2]

ElementBoundaryTypes & Dumux::FVLocalAssemblerBase< TypeTag, Assembler, FaceCenteredLocalAssembler< TypeTag, Assembler, DiffMethod::analytic, false > , useImplicitAssembly >::elemBcTypes ( )
inlineinherited

The element's boundary types.

◆ elemBcTypes() [2/2]

const ElementBoundaryTypes & Dumux::FVLocalAssemblerBase< TypeTag, Assembler, FaceCenteredLocalAssembler< TypeTag, Assembler, DiffMethod::analytic, false > , useImplicitAssembly >::elemBcTypes ( ) const
inlineinherited

The element's boundary types.

◆ element()

const Element & Dumux::FVLocalAssemblerBase< TypeTag, Assembler, FaceCenteredLocalAssembler< TypeTag, Assembler, DiffMethod::analytic, false > , useImplicitAssembly >::element ( ) const
inlineinherited

The current element.

◆ elementIsGhost()

bool Dumux::FVLocalAssemblerBase< TypeTag, Assembler, FaceCenteredLocalAssembler< TypeTag, Assembler, DiffMethod::analytic, false > , useImplicitAssembly >::elementIsGhost ( ) const
inlineinherited

Returns if element is a ghost entity.

◆ elemFluxVarsCache() [1/2]

ElementFluxVariablesCache & Dumux::FVLocalAssemblerBase< TypeTag, Assembler, FaceCenteredLocalAssembler< TypeTag, Assembler, DiffMethod::analytic, false > , useImplicitAssembly >::elemFluxVarsCache ( )
inlineinherited

The element flux variables cache.

◆ elemFluxVarsCache() [2/2]

const ElementFluxVariablesCache & Dumux::FVLocalAssemblerBase< TypeTag, Assembler, FaceCenteredLocalAssembler< TypeTag, Assembler, DiffMethod::analytic, false > , useImplicitAssembly >::elemFluxVarsCache ( ) const
inlineinherited

The element flux variables cache.

◆ enforceDirichletConstraints()

void Dumux::FaceCenteredLocalAssemblerBase< TypeTag, Assembler, FaceCenteredLocalAssembler< TypeTag, Assembler, DiffMethod::analytic, false > , implicit >::enforceDirichletConstraints ( const ApplyFunction &  applyDirichlet)
inlineinherited

Enforce Dirichlet constraints.

◆ enforceInternalDirichletConstraints() [1/2]

void Dumux::FVLocalAssemblerBase< TypeTag, Assembler, FaceCenteredLocalAssembler< TypeTag, Assembler, DiffMethod::analytic, false > , useImplicitAssembly >::enforceInternalDirichletConstraints ( const ApplyFunction &  applyDirichlet)
inlineinherited

Enforces Dirichlet constraints if enabled in the problem.

◆ enforceInternalDirichletConstraints() [2/2]

void Dumux::FVLocalAssemblerBase< TypeTag, Assembler, FaceCenteredLocalAssembler< TypeTag, Assembler, DiffMethod::analytic, false > , useImplicitAssembly >::enforceInternalDirichletConstraints ( const ApplyFunction &  applyDirichlet)
inlineinherited

◆ evalDirichletBoundaries()

void Dumux::FaceCenteredLocalAssemblerBase< TypeTag, Assembler, FaceCenteredLocalAssembler< TypeTag, Assembler, DiffMethod::analytic, false > , implicit >::evalDirichletBoundaries ( ApplyDirichletFunctionType  applyDirichlet)
inlineinherited

Evaluates Dirichlet boundaries.

◆ evalLocalFluxAndSourceResidual() [1/2]

ElementResidualVector Dumux::FVLocalAssemblerBase< TypeTag, Assembler, FaceCenteredLocalAssembler< TypeTag, Assembler, DiffMethod::analytic, false > , useImplicitAssembly >::evalLocalFluxAndSourceResidual ( ) const
inlineinherited

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.

◆ evalLocalFluxAndSourceResidual() [2/2]

ElementResidualVector Dumux::FVLocalAssemblerBase< TypeTag, Assembler, FaceCenteredLocalAssembler< TypeTag, Assembler, DiffMethod::analytic, false > , useImplicitAssembly >::evalLocalFluxAndSourceResidual ( const ElementVolumeVariables &  elemVolVars) const
inlineinherited

Evaluates the flux and source terms (i.e, the terms without a time derivative) of the local residual for the current element.

Parameters
elemVolVarsThe element volume variables

◆ evalLocalResidual() [1/2]

ElementResidualVector Dumux::FVLocalAssemblerBase< TypeTag, Assembler, FaceCenteredLocalAssembler< TypeTag, Assembler, DiffMethod::analytic, false > , useImplicitAssembly >::evalLocalResidual ( ) const
inlineinherited

Convenience function to evaluate the complete local residual for the current element. Automatically chooses the the appropriate element volume variables.

◆ evalLocalResidual() [2/2]

ElementResidualVector Dumux::FVLocalAssemblerBase< TypeTag, Assembler, FaceCenteredLocalAssembler< TypeTag, Assembler, DiffMethod::analytic, false > , useImplicitAssembly >::evalLocalResidual ( const ElementVolumeVariables &  elemVolVars) const
inlineinherited

Evaluates the complete local residual for the current element.

Parameters
elemVolVarsThe element volume variables

◆ evalLocalStorageResidual()

ElementResidualVector Dumux::FVLocalAssemblerBase< TypeTag, Assembler, FaceCenteredLocalAssembler< TypeTag, Assembler, DiffMethod::analytic, false > , useImplicitAssembly >::evalLocalStorageResidual ( ) const
inlineinherited

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.

◆ fvGeometry() [1/2]

FVElementGeometry & Dumux::FVLocalAssemblerBase< TypeTag, Assembler, FaceCenteredLocalAssembler< TypeTag, Assembler, DiffMethod::analytic, false > , useImplicitAssembly >::fvGeometry ( )
inlineinherited

The global finite volume geometry.

◆ fvGeometry() [2/2]

const FVElementGeometry & Dumux::FVLocalAssemblerBase< TypeTag, Assembler, FaceCenteredLocalAssembler< TypeTag, Assembler, DiffMethod::analytic, false > , useImplicitAssembly >::fvGeometry ( ) const
inlineinherited

The finite volume geometry.

◆ getVolVarAccess() [1/2]

VolumeVariables & Dumux::FVLocalAssemblerBase< TypeTag, Assembler, FaceCenteredLocalAssembler< TypeTag, Assembler, DiffMethod::analytic, false > , useImplicitAssembly >::getVolVarAccess ( GridVolumeVariables &  gridVolVars,
ElementVolumeVariables &  elemVolVars,
const SubControlVolume &  scv 
)
inlineprotectedinherited

◆ getVolVarAccess() [2/2]

VolumeVariables & Dumux::FVLocalAssemblerBase< TypeTag, Assembler, FaceCenteredLocalAssembler< TypeTag, Assembler, DiffMethod::analytic, false > , useImplicitAssembly >::getVolVarAccess ( GridVolumeVariables &  gridVolVars,
ElementVolumeVariables &  elemVolVars,
const SubControlVolume &  scv 
)
inlineprotectedinherited

◆ isImplicit()

static constexpr bool Dumux::FVLocalAssemblerBase< TypeTag, Assembler, FaceCenteredLocalAssembler< TypeTag, Assembler, DiffMethod::analytic, false > , useImplicitAssembly >::isImplicit ( )
inlinestaticconstexprinherited

Returns true if the assembler considers implicit assembly.

◆ localResidual() [1/2]

LocalResidual & Dumux::FVLocalAssemblerBase< TypeTag, Assembler, FaceCenteredLocalAssembler< TypeTag, Assembler, DiffMethod::analytic, false > , useImplicitAssembly >::localResidual ( )
inlineinherited

The local residual for the current element.

◆ localResidual() [2/2]

const LocalResidual & Dumux::FVLocalAssemblerBase< TypeTag, Assembler, FaceCenteredLocalAssembler< TypeTag, Assembler, DiffMethod::analytic, false > , useImplicitAssembly >::localResidual ( ) const
inlineinherited

The local residual for the current element.

◆ maybeEvalAdditionalDomainDerivatives()

void Dumux::FaceCenteredLocalAssemblerBase< TypeTag, Assembler, FaceCenteredLocalAssembler< TypeTag, Assembler, DiffMethod::analytic, false > , implicit >::maybeEvalAdditionalDomainDerivatives ( Args &&  ...)
inlineinherited

Update the additional domain derivatives for coupled models.

Note
This does nothing per default (not a coupled model).

◆ maybeUpdateCouplingContext()

void Dumux::FaceCenteredLocalAssemblerBase< TypeTag, Assembler, FaceCenteredLocalAssembler< TypeTag, Assembler, DiffMethod::analytic, false > , implicit >::maybeUpdateCouplingContext ( Args &&  ...)
inlineinherited

Update the coupling context for coupled models.

Note
This does nothing per default (not a coupled model).

◆ prevElemVolVars() [1/2]

ElementVolumeVariables & Dumux::FVLocalAssemblerBase< TypeTag, Assembler, FaceCenteredLocalAssembler< TypeTag, Assembler, DiffMethod::analytic, false > , useImplicitAssembly >::prevElemVolVars ( )
inlineinherited

The element volume variables of the provious time step.

◆ prevElemVolVars() [2/2]

const ElementVolumeVariables & Dumux::FVLocalAssemblerBase< TypeTag, Assembler, FaceCenteredLocalAssembler< TypeTag, Assembler, DiffMethod::analytic, false > , useImplicitAssembly >::prevElemVolVars ( ) const
inlineinherited

The element volume variables of the provious time step.

◆ problem()

const Problem & Dumux::FVLocalAssemblerBase< TypeTag, Assembler, FaceCenteredLocalAssembler< TypeTag, Assembler, DiffMethod::analytic, false > , useImplicitAssembly >::problem ( ) const
inlineinherited

The problem.


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