Coupling manager for the mixed u–p hyperelastic model. More...

#include <dumux/solidmechanics/hyperelastic_voliso/couplingmanager.hh>

Inheritance diagram for Dumux::HyperelasticVolIsoCouplingManager< MDTraits >:

Description

template<class MDTraits>
class Dumux::HyperelasticVolIsoCouplingManager< MDTraits >

Template Parameters

MDTraits MultiDomainTraits with subdomain 0 = momentum, subdomain 1 = pressure.

Public Types
using	CouplingStencilType = std::vector<std::size_t>

Public Member Functions
	HyperelasticVolIsoCouplingManager (std::shared_ptr< GridGeometry< momIdx_ > > momGG, std::shared_ptr< GridGeometry< presIdx_ > > presGG)
void	init (std::shared_ptr< GetPropType< SubDomainTypeTag< momIdx_ >, Properties::Problem > > momProblem, std::shared_ptr< GetPropType< SubDomainTypeTag< presIdx_ >, Properties::Problem > > presProblem, const SolutionVector &curSol)
template<std::size_t i, std::size_t j>
const CouplingStencilType &	couplingStencil (Dune::index_constant< i >, const Element< j > &element, Dune::index_constant< j >) const
Scalar	pressureAtPoint (const typename GridGeometry< momIdx_ >::LocalView &fvGeom, const GlobalPosition &ip) const
	Evaluate \( p_s \) at a global position (P1 interpolation from pressure solution).
Tensor	deformationGradientAtPoint (const typename GridGeometry< presIdx_ >::LocalView &fvGeom, const GlobalPosition &ip) const
	Evaluate \( \mathbf{F} \) at a global position (displacement shape functions).
void	computeColorsForAssembly ()
template<std::size_t i, class AssembleElementFunc>
void	assembleMultithreaded (Dune::index_constant< i >, AssembleElementFunc &&f) const
template<std::size_t i>
auto &	curSol (Dune::index_constant< i > id)
template<std::size_t i>
const auto &	curSol (Dune::index_constant< i > id) const
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
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

Static Public Attributes
static constexpr auto	momentumIdx = Dune::index_constant<momIdx_>()
static constexpr auto	pressureIdx = Dune::index_constant<presIdx_>()

Protected Types
using	SolutionVectorStorage
	the type in which the solution vector is stored in the manager

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
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
void	updateCoupledVariables (Dune::index_constant< i > domainI, const LocalAssemblerI &localAssemblerI, UpdatableElementVars &elemVars, UpdatableFluxVarCache &elemFluxVarsCache)
	update variables of domain i that depend on variables in domain j after the coupling context has been updated
void	updateCoupledVariables (Dune::index_constant< i > domainI, const LocalAssemblerI &localAssemblerI, UpdatableElementVars &elemVars)
	update variables of domain i that depend on variables in domain j after the coupling context has been updated
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.
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
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)
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
void	setSubProblems (const std::tuple< std::shared_ptr< SubProblems >... > &problems)
	set the pointers to the sub problems
void	setSubProblem (std::shared_ptr< SubProblem > problem, Dune::index_constant< i > domainIdx)
	set a pointer to one of the sub problems
const Problem< i > &	problem (Dune::index_constant< i > domainIdx) const
	Return a reference to the sub problem.
void	attachSolution (const SolutionVectorStorage &curSol)
	Attach a solution vector stored outside of this class.

Member Typedef Documentation

◆ CouplingStencilType

template<class MDTraits>

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

◆ SolutionVectorStorage

using Dumux::CouplingManager< MDTraits >::SolutionVectorStorage

protectedinherited

Constructor & Destructor Documentation

◆ HyperelasticVolIsoCouplingManager()

template<class MDTraits>

Dumux::HyperelasticVolIsoCouplingManager< MDTraits >::HyperelasticVolIsoCouplingManager	(	std::shared_ptr< GridGeometry< momIdx_ > >	momGG,
		std::shared_ptr< GridGeometry< presIdx_ > >	presGG )

inline

Member Function Documentation

◆ assembleMultithreaded()

template<class MDTraits>

template<std::size_t i, class AssembleElementFunc>

void Dumux::HyperelasticVolIsoCouplingManager< MDTraits >::assembleMultithreaded	(	Dune::index_constant< i >	,
		AssembleElementFunc &&	f ) const

inline

◆ attachSolution()

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

inlineprotectedinherited

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

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

◆ computeColorsForAssembly()

template<class MDTraits>

void Dumux::HyperelasticVolIsoCouplingManager< MDTraits >::computeColorsForAssembly ( )

inline

◆ couplingStencil() [1/2]

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

inlineinherited

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

template<class MDTraits>

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

const CouplingStencilType & Dumux::HyperelasticVolIsoCouplingManager< MDTraits >::couplingStencil	(	Dune::index_constant< i >	,
		const Element< j > &	element,
		Dune::index_constant< j >	) const

inline

◆ curSol() [1/2]

template<class MDTraits>

template<std::size_t i>

auto & Dumux::HyperelasticVolIsoCouplingManager< MDTraits >::curSol ( Dune::index_constant< i > id )

inline

◆ curSol() [2/2]

template<class MDTraits>

template<std::size_t i>

const auto & Dumux::HyperelasticVolIsoCouplingManager< MDTraits >::curSol ( Dune::index_constant< i > id ) const

inline

◆ deformationGradientAtPoint()

template<class MDTraits>

Tensor Dumux::HyperelasticVolIsoCouplingManager< MDTraits >::deformationGradientAtPoint	(	const typename GridGeometry< presIdx_ >::LocalView &	fvGeom,
		const GlobalPosition &	ip ) const

inline

◆ 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

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

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

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

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: if you overload this also implement evalAdditionalDomainDerivatives

◆ init()

template<class MDTraits>

void Dumux::HyperelasticVolIsoCouplingManager< MDTraits >::init	(	std::shared_ptr< GetPropType< SubDomainTypeTag< momIdx_ >, Properties::Problem > >	momProblem,
		std::shared_ptr< GetPropType< SubDomainTypeTag< presIdx_ >, Properties::Problem > >	presProblem,
		const SolutionVector &	curSol )

inline

◆ numericEpsilon()

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

inlineinherited

◆ pressureAtPoint()

template<class MDTraits>

Scalar Dumux::HyperelasticVolIsoCouplingManager< MDTraits >::pressureAtPoint	(	const typename GridGeometry< momIdx_ >::LocalView &	fvGeom,
		const GlobalPosition &	ip ) const

inline

◆ problem()

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

inlineinherited

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

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

Parameters

problems A tuple of shared pointers to the sub problems

◆ updateCoupledVariables() [1/2]

void Dumux::CouplingManager< MDTraits >::updateCoupledVariables	(	Dune::index_constant< i >	domainI,
		const LocalAssemblerI &	localAssemblerI,
		UpdatableElementVars &	elemVars )

inlineinherited

Parameters

domainI	the index of domain i
localAssemblerI	the local assembler assembling the element residual of an element of domain i
elemVars	the element variables (all 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 poromechanics: 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); this overload is for the case that the new grid variables concept is used and thus, all cached data is stored / updated in the grid variables.

◆ updateCoupledVariables() [2/2]

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

inlineinherited

Parameters

domainI	the index of domain i
localAssemblerI	the local assembler assembling the element residual of an element of domain i
elemVars	the element variables (all 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 poromechanics: 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()

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

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

Member Data Documentation

◆ momentumIdx

template<class MDTraits>

auto Dumux::HyperelasticVolIsoCouplingManager< MDTraits >::momentumIdx = Dune::index_constant<momIdx_>()

staticconstexpr

◆ pressureIdx

template<class MDTraits>

auto Dumux::HyperelasticVolIsoCouplingManager< MDTraits >::pressureIdx = Dune::index_constant<presIdx_>()

staticconstexpr

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

solidmechanics/hyperelastic_voliso/couplingmanager.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

◆ SolutionVectorStorage

Constructor & Destructor Documentation

◆ HyperelasticVolIsoCouplingManager()

Member Function Documentation

◆ assembleMultithreaded()

◆ attachSolution()

◆ bindCouplingContext()

◆ computeColorsForAssembly()

◆ couplingStencil() [1/2]

◆ couplingStencil() [2/2]

◆ curSol() [1/2]

◆ curSol() [2/2]

◆ deformationGradientAtPoint()

◆ evalAdditionalDomainDerivatives()

◆ evalCouplingResidual()

◆ extendJacobianPattern()

◆ init()

◆ numericEpsilon()

◆ pressureAtPoint()

◆ problem()

◆ setSubProblem()

◆ setSubProblems()

◆ updateCoupledVariables() [1/2]

◆ updateCoupledVariables() [2/2]

◆ updateCouplingContext()

◆ updateSolution()

Member Data Documentation

◆ momentumIdx

◆ pressureIdx