Base coupling manager for the staggered discretization. More...

#include <dumux/multidomain/staggeredcouplingmanager.hh>

Inheritance diagram for Dumux::StaggeredCouplingManager< MDTraits >:

Description

template<class MDTraits>
class Dumux::StaggeredCouplingManager< MDTraits >

Base coupling manager for the staggered discretization.

Public Types
using	Traits = MDTraits

using	CouplingStencilType = std::vector< std::size_t >
	default type used for coupling element stencils More...

using	SolutionVector = typename Traits::SolutionVector
	the type of the solution vector More...

Public Member Functions
template<std::size_t i, std::size_t j, class LocalAssemblerI , class PriVarsJ >
void	updateCouplingContext (Dune::index_constant< i > domainI, const LocalAssemblerI &localAssemblerI, Dune::index_constant< j > domainJ, const std::size_t dofIdxGlobalJ, const PriVarsJ &priVarsJ, int pvIdxJ)
	updates all data and variables that are necessary to evaluate the residual of the element of domain i this is called whenever one of the primary variables that the element residual depends on changes in domain j More...

const CouplingStencil &	couplingStencil (Dune::index_constant< cellCenterIdx > domainI, const Element &elementI, Dune::index_constant< faceIdx > domainJ) const
	returns an iterable container of all indices of degrees of freedom of domain j that couple with / influence the element residual of the given element of domain i More...

template<std::size_t i, std::size_t j>
const CouplingStencil	couplingStencil (Dune::index_constant< i > domainI, const SubControlVolumeFace &scvfI, Dune::index_constant< j > domainJ) const
	returns an iterable container of all indices of degrees of freedom of domain j that couple with / influence the residual of the given subcontrolvolume face of domain i More...

const CouplingStencil &	couplingStencil (Dune::index_constant< faceIdx > domainI, const SubControlVolumeFace &scvfI, Dune::index_constant< cellCenterIdx > domainJ) const
	returns an iterable container of all indices of degrees of freedom of domain j that couple with / influence the residual of the given subcontrolvolume face of domain i More...

template<class LocalAssemblerI , std::size_t j>
decltype(auto)	evalCouplingResidual (Dune::index_constant< cellCenterIdx > domainI, const LocalAssemblerI &localAssemblerI, Dune::index_constant< j > domainJ, std::size_t dofIdxGlobalJ) const
	evaluates the element residual of a coupled element of domain i which depends on the variables at the degree of freedom with index dofIdxGlobalJ of domain j More...

template<class LocalAssemblerI , std::size_t j>
decltype(auto)	evalCouplingResidual (Dune::index_constant< faceIdx > domainI, const SubControlVolumeFace &scvfI, const LocalAssemblerI &localAssemblerI, Dune::index_constant< j > domainJ, std::size_t dofIdxGlobalJ) const
	evaluates the face residual of a coupled face of domain i which depends on the variables at the degree of freedom with index dofIdxGlobalJ of domain j More...

template<std::size_t i, typename std::enable_if_t<(GridGeometry< i >::discMethod !=DiscretizationMethods::staggered), int > = 0>
decltype(auto)	numericEpsilon (Dune::index_constant< i > id, const std::string &paramGroup) const
	return the numeric epsilon used for deflecting primary variables of coupled domain i. More...

template<std::size_t i, typename std::enable_if_t<(GridGeometry< i >::discMethod==DiscretizationMethods::staggered), int > = 0>
decltype(auto)	numericEpsilon (Dune::index_constant< i >, const std::string &paramGroup) const
	return the numeric epsilon used for deflecting primary variables of coupled domain i. More...

member functions concerning the coupling stencils
const CouplingStencilType< i, j > &	couplingStencil (Dune::index_constant< i > domainI, const Element< i > &elementI, Dune::index_constant< j > domainJ) const
	returns an iterable container of all indices of degrees of freedom of domain j that couple with / influence the element residual of the given element of domain i More...

void	extendJacobianPattern (Dune::index_constant< id > domainI, JacobianPattern &pattern) const
	extend the jacobian pattern of the diagonal block of domain i by those entries that are not already in the uncoupled pattern More...

Static Public Attributes
static constexpr auto	cellCenterIdx = GridGeometry<0>::cellCenterIdx()

static constexpr auto	faceIdx = GridGeometry<0>::faceIdx()

Protected Types
using	SolutionVectorStorage = typename Traits::template TupleOfSharedPtr< SubSolutionVector >
	the type in which the solution vector is stored in the manager More...

member functions concerning variable caching for element residual evaluations
void	bindCouplingContext (Dune::index_constant< i > domainI, const Element< i > &elementI, const Assembler &assembler)
	prepares all data and variables that are necessary to evaluate the residual of the element of domain i More...

void	updateCouplingContext (Dune::index_constant< i > domainI, const LocalAssemblerI &localAssemblerI, Dune::index_constant< j > domainJ, std::size_t dofIdxGlobalJ, const PrimaryVariables< j > &priVarsJ, int pvIdxJ)
	updates all data and variables that are necessary to evaluate the residual of the element of domain i this is called whenever one of the primary variables that the element residual depends on changes in domain j More...

void	updateCoupledVariables (Dune::index_constant< i > domainI, const LocalAssemblerI &localAssemblerI, UpdatableElementVolVars &elemVolVars, UpdatableFluxVarCache &elemFluxVarsCache)
	update variables of domain i that depend on variables in domain j after the coupling context has been updated More...

void	updateSolution (const SolutionVector &curSol)
	Updates the entire solution vector, e.g. before assembly or after grid adaption Overload might want to overload function if the solution vector is stored outside this class to make sure updates don't happen more than once. More...

decltype(auto)	evalCouplingResidual (Dune::index_constant< i > domainI, const LocalAssemblerI &localAssemblerI, Dune::index_constant< j > domainJ, std::size_t dofIdxGlobalJ) const
	evaluates the element residual of a coupled element of domain i which depends on the variables at the degree of freedom with index dofIdxGlobalJ of domain j More...

void	evalAdditionalDomainDerivatives (Dune::index_constant< i > domainI, const LocalAssemblerI &localAssemblerI, const typename LocalAssemblerI::LocalResidual::ElementResidualVector &origResiduals, JacobianMatrixDiagBlock &A, GridVariables &gridVariables)
	evaluate additional derivatives of the element residual of a domain with respect to dofs in the same domain that are not in the regular stencil (see CouplingManager::extendJacobianPattern) More...

void	setSubProblems (const std::tuple< std::shared_ptr< SubProblems >... > &problems)
	set the pointers to the sub problems More...

void	setSubProblem (std::shared_ptr< SubProblem > problem, Dune::index_constant< i > domainIdx)
	set a pointer to one of the sub problems More...

const Problem< i > &	problem (Dune::index_constant< i > domainIdx) const
	Return a reference to the sub problem. More...

void	attachSolution (SolutionVectorStorage &curSol)
	Attach a solution vector stored outside of this class. More...

SubSolutionVector< i > &	curSol (Dune::index_constant< i > domainIdx)
	the solution vector of the subproblem More...

const SubSolutionVector< i > &	curSol (Dune::index_constant< i > domainIdx) const
	the solution vector of the subproblem More...

Member Typedef Documentation

◆ CouplingStencilType

using Dumux::CouplingManager< MDTraits >::CouplingStencilType = std::vector<std::size_t>

inherited

default type used for coupling element stencils

◆ SolutionVector

using Dumux::CouplingManager< MDTraits >::SolutionVector = typename Traits::SolutionVector

inherited

the type of the solution vector

◆ SolutionVectorStorage

using Dumux::CouplingManager< MDTraits >::SolutionVectorStorage = typename Traits::template TupleOfSharedPtr<SubSolutionVector>

protectedinherited

the type in which the solution vector is stored in the manager

◆ Traits

template<class MDTraits >

using Dumux::StaggeredCouplingManager< MDTraits >::Traits = MDTraits

Member Function Documentation

◆ attachSolution()

void Dumux::CouplingManager< MDTraits >::attachSolution ( SolutionVectorStorage & curSol )

inlineprotectedinherited

Attach a solution vector stored outside of this class.

Note: The caller has to make sure that curSol stays alive for the lifetime of the coupling manager. Otherwise we have a dangling reference here. Use with care.

◆ bindCouplingContext()

void Dumux::CouplingManager< MDTraits >::bindCouplingContext	(	Dune::index_constant< i >	domainI,
		const Element< i > &	elementI,
		const Assembler &	assembler
	)

inlineinherited

prepares all data and variables that are necessary to evaluate the residual of the element of domain i

Parameters

domainI	the domain index of domain i
elementI	the element whose residual we are assemling next
assembler	the multidomain assembler for access to all data necessary for the assembly of all domains

Note: this concerns all data that is used in the evaluation of the element residual and depends on one of the degrees of freedom returned by CouplingManager::couplingStencil; every coupled element residual depends at least on the solution of another domain, that why we always store a copy of the solution vector in the coupling manager, hence, in case the element residual only depends on primary variables of the other domain this function does nothing; overload this function in case the element residual depends on more than the primary variables of domain j

◆ couplingStencil() [1/4]

template<class MDTraits >

const CouplingStencil & Dumux::StaggeredCouplingManager< MDTraits >::couplingStencil	(	Dune::index_constant< cellCenterIdx >	domainI,
		const Element &	elementI,
		Dune::index_constant< faceIdx >	domainJ
	)		const

inline

returns an iterable container of all indices of degrees of freedom of domain j that couple with / influence the element residual of the given element of domain i

Parameters

domainI	the domain index of domain i
elementI	the coupled element of domain í
domainJ	the domain index of domain j

Note: this is a specialization for getting the indices of the coupled staggered face dofs

◆ couplingStencil() [2/4]

template<class MDTraits >

const CouplingStencil & Dumux::StaggeredCouplingManager< MDTraits >::couplingStencil	(	Dune::index_constant< faceIdx >	domainI,
		const SubControlVolumeFace &	scvfI,
		Dune::index_constant< cellCenterIdx >	domainJ
	)		const

inline

returns an iterable container of all indices of degrees of freedom of domain j that couple with / influence the residual of the given subcontrolvolume face of domain i

Parameters

domainI	the domain index of domain i
scvfI	the coupled subcontrolvolume face of domain í
domainJ	the domain index of domain j

Note: this is a specialization for getting the indices of the coupled cellcentered dofs

◆ couplingStencil() [3/4]

const CouplingStencilType< i, j > & Dumux::CouplingManager< MDTraits >::couplingStencil	(	Dune::index_constant< i >	domainI,
		const Element< i > &	elementI,
		Dune::index_constant< j >	domainJ
	)		const

inlineinherited

returns an iterable container of all indices of degrees of freedom of domain j that couple with / influence the element residual of the given element of domain i

Parameters

domainI	the domain index of domain i
elementI	the coupled element of domain í
domainJ	the domain index of domain j

Note: The element residual definition depends on the discretization scheme of domain i box: a container of the residuals of all sub control volumes cc : the residual of the (sub) control volume fem: the residual of the element; This function has to be implemented by all coupling managers for all combinations of i and j

◆ couplingStencil() [4/4]

template<class MDTraits >

template<std::size_t i, std::size_t j>

const CouplingStencil Dumux::StaggeredCouplingManager< MDTraits >::couplingStencil	(	Dune::index_constant< i >	domainI,
		const SubControlVolumeFace &	scvfI,
		Dune::index_constant< j >	domainJ
	)		const

inline

returns an iterable container of all indices of degrees of freedom of domain j that couple with / influence the residual of the given subcontrolvolume face of domain i

Parameters

domainI	the domain index of domain i
scvfI	the coupled subcontrolvolume face of domain í
domainJ	the domain index of domain j

Note: This function has to be implemented by all coupling managers for all combinations of i and j

◆ curSol() [1/2]

SubSolutionVector & Dumux::CouplingManager< MDTraits >::curSol ( Dune::index_constant domainIdx )

inlineprotectedinherited

the solution vector of the subproblem

Parameters

domainIdx The domain index

Note: in case of numeric differentiation the solution vector always carries the deflected solution

◆ curSol() [2/2]

const SubSolutionVector & Dumux::CouplingManager< MDTraits >::curSol ( Dune::index_constant domainIdx ) const

inlineprotectedinherited

the solution vector of the subproblem

Parameters

domainIdx The domain index

Note: in case of numeric differentiation the solution vector always carries the deflected solution

◆ evalAdditionalDomainDerivatives()

void Dumux::CouplingManager< MDTraits >::evalAdditionalDomainDerivatives	(	Dune::index_constant< i >	domainI,
		const LocalAssemblerI &	localAssemblerI,
		const typename LocalAssemblerI::LocalResidual::ElementResidualVector &	origResiduals,
		JacobianMatrixDiagBlock &	A,
		GridVariables &	gridVariables
	)

inlineinherited

evaluate additional derivatives of the element residual of a domain with respect to dofs in the same domain that are not in the regular stencil (see CouplingManager::extendJacobianPattern)

Note: Such additional dependencies can arise from the coupling, e.g. if a coupling source term depends on a non-local average of a quantity of the same domain

◆ evalCouplingResidual() [1/2]

template<class MDTraits >

template<class LocalAssemblerI , std::size_t j>

decltype(auto) Dumux::StaggeredCouplingManager< MDTraits >::evalCouplingResidual	(	Dune::index_constant< cellCenterIdx >	domainI,
		const LocalAssemblerI &	localAssemblerI,
		Dune::index_constant< j >	domainJ,
		std::size_t	dofIdxGlobalJ
	)		const

inline

evaluates the element residual of a coupled element of domain i which depends on the variables at the degree of freedom with index dofIdxGlobalJ of domain j

Parameters

domainI	the domain index of domain i
localAssemblerI	the local assembler assembling the element residual of an element of domain i
domainJ	the domain index of domain j
dofIdxGlobalJ	the index of the degree of freedom of domain j which has an influence on the element residual of domain i

Note: the element whose residual is to be evaluated can be retrieved from the local assembler as localAssemblerI.element() as well as all up-to-date variables and caches.; the default implementation evaluates the complete element residual if only parts (i.e. only certain scvs, or only certain terms of the residual) of the residual are coupled to dof with index dofIdxGlobalJ the function can be overloaded in the coupling manager

Returns: the element residual

Note: this is a specialization for calculating the coupled residual for cellcentered dofs w.r.t. staggered face dof changes

◆ evalCouplingResidual() [2/2]

decltype(auto) Dumux::CouplingManager< MDTraits >::evalCouplingResidual	(	Dune::index_constant< i >	domainI,
		const LocalAssemblerI &	localAssemblerI,
		Dune::index_constant< j >	domainJ,
		std::size_t	dofIdxGlobalJ
	)		const

inlineinherited

evaluates the element residual of a coupled element of domain i which depends on the variables at the degree of freedom with index dofIdxGlobalJ of domain j

Parameters

domainI	the domain index of domain i
localAssemblerI	the local assembler assembling the element residual of an element of domain i
domainJ	the domain index of domain j
dofIdxGlobalJ	the index of the degree of freedom of domain j which has an influence on the element residual of domain i

Note: the element whose residual is to be evaluated can be retrieved from the local assembler as localAssemblerI.element() as well as all up-to-date variables and caches.; the default implementation evaluates the complete element residual if only parts (i.e. only certain scvs, or only certain terms of the residual) of the residual are coupled to dof with index dofIdxGlobalJ the function can be overloaded in the coupling manager

Returns: the element residual

◆ extendJacobianPattern()

void Dumux::CouplingManager< MDTraits >::extendJacobianPattern	(	Dune::index_constant< id >	domainI,
		JacobianPattern &	pattern
	)		const

inlineinherited

extend the jacobian pattern of the diagonal block of domain i by those entries that are not already in the uncoupled pattern

Note: per default we do not add such additional dependencies; Such additional dependencies can arise from the coupling, e.g. if a coupling source term depends on a non-local average of a quantity of the same domain

Warning List:: if you overload this also implement evalAdditionalDomainDerivatives

◆ numericEpsilon() [1/2]

template<class MDTraits >

template<std::size_t i, typename std::enable_if_t<(GridGeometry::discMethod !=DiscretizationMethods::staggered), int > = 0>

decltype(auto) Dumux::StaggeredCouplingManager< MDTraits >::numericEpsilon	(	Dune::index_constant< i >	id,
		const std::string &	paramGroup
	)		const

inline

return the numeric epsilon used for deflecting primary variables of coupled domain i.

Note: specialization for non-staggered schemes

◆ numericEpsilon() [2/2]

template<class MDTraits >

template<std::size_t i, typename std::enable_if_t<(GridGeometry::discMethod==DiscretizationMethods::staggered), int > = 0>

decltype(auto) Dumux::StaggeredCouplingManager< MDTraits >::numericEpsilon	(	Dune::index_constant< i >	,
		const std::string &	paramGroup
	)		const

inline

return the numeric epsilon used for deflecting primary variables of coupled domain i.

Note: specialization for non-staggered schemes

◆ problem()

const Problem & Dumux::CouplingManager< MDTraits >::problem ( Dune::index_constant domainIdx ) const

inlineinherited

Return a reference to the sub problem.

Parameters

domainIdx The domain index We avoid exception handling here because the performance of this function is critical

◆ setSubProblem()

void Dumux::CouplingManager< MDTraits >::setSubProblem	(	std::shared_ptr< SubProblem >	problem,
		Dune::index_constant< i >	domainIdx
	)

inlineinherited

set a pointer to one of the sub problems

Parameters

problem	a pointer to the sub problem
domainIdx	the domain index of the sub problem

◆ setSubProblems()

void Dumux::CouplingManager< MDTraits >::setSubProblems ( const std::tuple< std::shared_ptr< SubProblems >... > & problems )

inlineinherited

set the pointers to the sub problems

Parameters

problems A tuple of shared pointers to the sub problems

◆ updateCoupledVariables()

void Dumux::CouplingManager< MDTraits >::updateCoupledVariables	(	Dune::index_constant< i >	domainI,
		const LocalAssemblerI &	localAssemblerI,
		UpdatableElementVolVars &	elemVolVars,
		UpdatableFluxVarCache &	elemFluxVarsCache
	)

inlineinherited

update variables of domain i that depend on variables in domain j after the coupling context has been updated

Parameters

domainI	the index of domain i
localAssemblerI	the local assembler assembling the element residual of an element of domain i
elemVolVars	the element volume variables (all volume variables in the element local stencil) to be updated
elemFluxVarsCache	the element flux variable cache (all flux variables in the element local stencil) to be updated

Note: Such variables do not necessarily exist and then this function does nothing (default); some examples from geomechanics: the porosity of (physical) domain i (porous medium flow) depends on the displacement vector of physical domain j (mechanics) from domaindecomposition: the transmissibilities for fluxes of domain i to domain j depend on the permeability in domain j (which might depend in turn on the primary variables of domain i)

◆ updateCouplingContext() [1/2]

template<class MDTraits >

template<std::size_t i, std::size_t j, class LocalAssemblerI , class PriVarsJ >

void Dumux::StaggeredCouplingManager< MDTraits >::updateCouplingContext	(	Dune::index_constant< i >	domainI,
		const LocalAssemblerI &	localAssemblerI,
		Dune::index_constant< j >	domainJ,
		const std::size_t	dofIdxGlobalJ,
		const PriVarsJ &	priVarsJ,
		int	pvIdxJ
	)

inline

updates all data and variables that are necessary to evaluate the residual of the element of domain i this is called whenever one of the primary variables that the element residual depends on changes in domain j

Parameters

domainI	the domain index of domain i
localAssemblerI	the local assembler assembling the element residual of an element of domain i
domainJ	the domain index of domain j
dofIdxGlobalJ	the index of the degree of freedom of domain j whose solution changed
priVarsJ	the new solution at the degree of freedom of domain j with index dofIdxGlobalJ
pvIdxJ	the index of the primary variable of domain j which has been updated

Note: this concerns all data that is used in the evaluation of the element residual and depends on the primary variables at the degree of freedom location with index dofIdxGlobalJ; the element whose residual is to be evaluated can be retrieved from the local assembler as localAssemblerI.element(); per default, we update the solution vector, if the element residual of domain i depends on more than the primary variables of domain j update the other dependent data here by overloading this function

◆ updateCouplingContext() [2/2]

void Dumux::CouplingManager< MDTraits >::updateCouplingContext	(	Dune::index_constant< i >	domainI,
		const LocalAssemblerI &	localAssemblerI,
		Dune::index_constant< j >	domainJ,
		std::size_t	dofIdxGlobalJ,
		const PrimaryVariables< j > &	priVarsJ,
		int	pvIdxJ
	)

inlineinherited

updates all data and variables that are necessary to evaluate the residual of the element of domain i this is called whenever one of the primary variables that the element residual depends on changes in domain j

Parameters

domainI	the domain index of domain i
localAssemblerI	the local assembler assembling the element residual of an element of domain i
domainJ	the domain index of domain j
dofIdxGlobalJ	the index of the degree of freedom of domain j whose solution changed
priVarsJ	the new solution at the degree of freedom of domain j with index dofIdxGlobalJ
pvIdxJ	the index of the primary variable of domain j which has been updated

Note: this concerns all data that is used in the evaluation of the element residual and depends on the primary variables at the degree of freedom location with index dofIdxGlobalJ; the element whose residual is to be evaluated can be retrieved from the local assembler as localAssemblerI.element(); per default, we update the solution vector, if the element residual of domain i depends on more than the primary variables of domain j update the other dependent data here by overloading this function

◆ updateSolution()

void Dumux::CouplingManager< MDTraits >::updateSolution ( const SolutionVector & curSol )

inlineinherited

Updates the entire solution vector, e.g. before assembly or after grid adaption Overload might want to overload function if the solution vector is stored outside this class to make sure updates don't happen more than once.

Member Data Documentation

◆ cellCenterIdx

template<class MDTraits >

constexpr auto Dumux::StaggeredCouplingManager< MDTraits >::cellCenterIdx = GridGeometry<0>::cellCenterIdx()

staticconstexpr

◆ faceIdx

template<class MDTraits >

constexpr auto Dumux::StaggeredCouplingManager< MDTraits >::faceIdx = GridGeometry<0>::faceIdx()

staticconstexpr

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

staggeredcouplingmanager.hh

Description

Public Types

Public Member Functions

Static Public Attributes

Protected Types

member functions concerning variable caching for element residual evaluations

Member Typedef Documentation

◆ CouplingStencilType

◆ SolutionVector

◆ SolutionVectorStorage

◆ Traits

Member Function Documentation

◆ attachSolution()

◆ bindCouplingContext()

◆ couplingStencil() [1/4]

◆ couplingStencil() [2/4]

◆ couplingStencil() [3/4]

◆ couplingStencil() [4/4]

◆ curSol() [1/2]

◆ curSol() [2/2]

◆ evalAdditionalDomainDerivatives()

◆ evalCouplingResidual() [1/2]

◆ evalCouplingResidual() [2/2]

◆ extendJacobianPattern()

◆ numericEpsilon() [1/2]

◆ numericEpsilon() [2/2]

◆ problem()

◆ setSubProblem()

◆ setSubProblems()

◆ updateCoupledVariables()

◆ updateCouplingContext() [1/2]

◆ updateCouplingContext() [2/2]

◆ updateSolution()

Member Data Documentation

◆ cellCenterIdx

◆ faceIdx