The interface of the coupling manager for multi domain problems. More...

#include <dumux/multidomain/couplingmanager.hh>

Inheritance diagram for Dumux::CouplingManager< Traits >:

Description

template<class Traits>
class Dumux::CouplingManager< Traits >

The interface of the coupling manager for multi domain problems.

Public Types
template<std::size_t i, std::size_t j>
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
	CouplingManager ()
	Default constructor. More...

member functions concerning the coupling stencils
template<std::size_t i, std::size_t j>
const CouplingStencilType< i, j > &	couplingStencil (Dune::index_constant< i > domainI, const Element< i > &elementI, Dune::index_constant< j > domainJ) const
	returns an iteratable 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 id, class JacobianPattern >
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...

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
template<std::size_t i, class Assembler >
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...

template<std::size_t i, std::size_t j, class LocalAssemblerI >
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...

template<std::size_t i, class LocalAssemblerI , class UpdatableElementVolVars , class UpdatableFluxVarCache >
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...

template<std::size_t i, std::size_t j, class LocalAssemblerI >
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...

template<std::size_t i, class LocalAssemblerI , class JacobianMatrixDiagBlock , class GridVariables >
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...

template<std::size_t i>
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...

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

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

template<std::size_t i>
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...

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

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

decltype(auto)	curSol ()
	the solution vector of the coupled problem More...

decltype(auto)	curSol () const
	the solution vector of the coupled problem More...

Member Typedef Documentation

◆ CouplingStencilType

template<class Traits >

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

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

default type used for coupling element stencils

◆ SolutionVector

template<class Traits >

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

the type of the solution vector

◆ SolutionVectorStorage

template<class Traits >

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

protected

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

Constructor & Destructor Documentation

◆ CouplingManager()

template<class Traits >

Dumux::CouplingManager< Traits >::CouplingManager ( )

inline

Default constructor.

The coupling manager stores pointers to the sub-solution vectors. Note that they can be either owning pointers (default updateSolution) or non-owning. In the non-owning case attach the solution vector managed elsewhere using attachSolution and make sure that object stays alive of the lifetime of the coupling manager.

Member Function Documentation

◆ attachSolution()

template<class Traits >

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

inlineprotected

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()

template<class Traits >

template<std::size_t i, class Assembler >

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

inline

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()

template<class Traits >

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

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

inline

returns an iteratable 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

◆ curSol() [1/4]

template<class Traits >

decltype(auto) Dumux::CouplingManager< Traits >::curSol ( )

inlineprotected

the solution vector of the coupled problem

Note: in case of numeric differentiation the solution vector always carries the deflected solution The type returned does not allow assignment from a "regular" MultiTypeBlockVector (not holding references). curSol() = x; won't compile. Use couplingManager.updateSolution(x) instead or (better) use the new curSol(idx) interface.

◆ curSol() [2/4]

template<class Traits >

decltype(auto) Dumux::CouplingManager< Traits >::curSol ( ) const

inlineprotected

the solution vector of the coupled problem

Note: in case of numeric differentiation the solution vector always carries the deflected solution The type returned does not allow assignment from a "regular" MultiTypeBlockVector (not holding references) curSol() = x; // won't compile. Use couplingManager.updateSolution(x) instead or (better) use the new curSol(idx) interface.

◆ curSol() [3/4]

template<class Traits >

template<std::size_t i>

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

inlineprotected

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() [4/4]

template<class Traits >

template<std::size_t i>

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

inlineprotected

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()

template<class Traits >

template<std::size_t i, class LocalAssemblerI , class JacobianMatrixDiagBlock , class GridVariables >

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

inline

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

◆ extendJacobianPattern()

template<class Traits >

template<std::size_t id, class JacobianPattern >

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

inline

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()

template<class Traits >

template<std::size_t i>

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

inline

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

◆ problem()

template<class Traits >

template<std::size_t i>

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

inline

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()

template<class Traits >

template<class SubProblem , std::size_t i>

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

inline

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()

template<class Traits >

template<typename... SubProblems>

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

inline

set the pointers to the sub problems

Parameters

problems A tuple of shared pointers to the sub problems

◆ updateCoupledVariables()

template<class Traits >

template<std::size_t i, class LocalAssemblerI , class UpdatableElementVolVars , class UpdatableFluxVarCache >

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

inline

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 (mechnanics) 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)

◆ updateSolution()

template<class Traits >

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

inline

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.

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

multidomain/couplingmanager.hh

Description

Public Types

Public Member Functions

Protected Types

member functions concerning variable caching for element residual evaluations

Member Typedef Documentation

◆ CouplingStencilType

◆ SolutionVector

◆ SolutionVectorStorage

Constructor & Destructor Documentation

◆ CouplingManager()

Member Function Documentation

◆ attachSolution()

◆ bindCouplingContext()

◆ couplingStencil()

◆ curSol() [1/4]

◆ curSol() [2/4]

◆ curSol() [3/4]

◆ curSol() [4/4]

◆ evalAdditionalDomainDerivatives()

◆ extendJacobianPattern()

◆ numericEpsilon()

◆ problem()

◆ setSubProblem()

◆ setSubProblems()

◆ updateCoupledVariables()

◆ updateSolution()