version 3.11-dev
Dumux::MindlinReissnerPlateCouplingManager< MDTraits > Class Template Reference

#include <dumux/solidmechanics/plate/mindlin_reissner/model.hh>

Inheritance diagram for Dumux::MindlinReissnerPlateCouplingManager< MDTraits >:

Public Types

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

Public Member Functions

void init (std::shared_ptr< Problem< rotationIdx > > momentumProblem, std::shared_ptr< Problem< deformationIdx > > massProblem, const SolutionVector &curSol)
 
template<std::size_t i, std::size_t j>
const CouplingStencil< j > & couplingStencil (Dune::index_constant< i > domainI, const Element< i > &element, Dune::index_constant< j > domainJ) const
 
auto rotation (typename GridGeometry< deformationIdx >::LocalView const &fvGeometry, typename GridGeometry< deformationIdx >::SubControlVolumeFace const &scvf) const
 
auto deformationAndPotentials (typename GridGeometry< rotationIdx >::LocalView const &fvGeometry, typename GridGeometry< rotationIdx >::SubControlVolumeFace const &scvf) const
 
auto shearCurlPotentialIdx () const
 
auto shearGradPotentialIdx () const
 
template<std::size_t i>
auto & curSol (Dune::index_constant< i > domainIdx)
 the solution vector of the subproblem More...
 
template<std::size_t i>
const auto & curSol (Dune::index_constant< i > domainIdx) const
 the solution vector of the subproblem More...
 
void computeColorsForAssembly ()
 Compute colors for multithreaded assembly. More...
 
template<std::size_t i, class AssembleElementFunc >
void assembleMultithreaded (Dune::index_constant< i > domainId, AssembleElementFunc &&assembleElement) const
 Execute assembly kernel in parallel. More...
 
member functions concerning the coupling stencils
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 rotationIdx = typename MDTraits::template SubDomain<0>::Index()
 
static constexpr auto deformationIdx = typename MDTraits::template SubDomain<1>::Index()
 

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, UpdatableElementVars &elemVars, UpdatableFluxVarCache &elemFluxVarsCache)
 update variables of domain i that depend on variables in domain j after the coupling context has been updated More...
 
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 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...
 
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...
 
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 (const SolutionVectorStorage &curSol)
 Attach a solution vector stored outside of this class. More...
 

Member Typedef Documentation

◆ CouplingStencilType

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

◆ MultiDomainTraits

template<class MDTraits >
using Dumux::KirchhoffLovePlateCouplingManager< MDTraits >::MultiDomainTraits = MDTraits
inherited

◆ SolutionVectorStorage

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

Member Function Documentation

◆ assembleMultithreaded()

template<class MDTraits >
template<std::size_t i, class AssembleElementFunc >
void Dumux::KirchhoffLovePlateCouplingManager< MDTraits >::assembleMultithreaded ( Dune::index_constant< i >  domainId,
AssembleElementFunc &&  assembleElement 
) const
inlineinherited
Parameters
domainIdthe domain index of domain i
assembleElementkernel function to execute for one element

◆ 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
domainIthe domain index of domain i
elementIthe element whose residual we are assemling next
assemblerthe 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::KirchhoffLovePlateCouplingManager< MDTraits >::computeColorsForAssembly ( )
inlineinherited

◆ couplingStencil()

template<class MDTraits >
template<std::size_t i, std::size_t j>
const CouplingStencil< j > & Dumux::KirchhoffLovePlateCouplingManager< MDTraits >::couplingStencil ( Dune::index_constant< i >  domainI,
const Element< i > &  element,
Dune::index_constant< j >  domainJ 
) const
inlineinherited

◆ curSol() [1/2]

template<class MDTraits >
template<std::size_t i>
auto & Dumux::KirchhoffLovePlateCouplingManager< MDTraits >::curSol ( Dune::index_constant< i >  domainIdx)
inlineinherited
Parameters
domainIdxThe domain index
Note
in case of numeric differentiation the solution vector always carries the deflected solution

◆ curSol() [2/2]

template<class MDTraits >
template<std::size_t i>
const auto & Dumux::KirchhoffLovePlateCouplingManager< MDTraits >::curSol ( Dune::index_constant< i >  domainIdx) const
inlineinherited
Parameters
domainIdxThe domain index
Note
in case of numeric differentiation the solution vector always carries the deflected solution

◆ deformationAndPotentials()

template<class MDTraits >
auto Dumux::KirchhoffLovePlateCouplingManager< MDTraits >::deformationAndPotentials ( typename GridGeometry< rotationIdx >::LocalView const &  fvGeometry,
typename GridGeometry< rotationIdx >::SubControlVolumeFace const &  scvf 
) const
inlineinherited

◆ 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
domainIthe domain index of domain i
localAssemblerIthe local assembler assembling the element residual of an element of domain i
domainJthe domain index of domain j
dofIdxGlobalJthe 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::KirchhoffLovePlateCouplingManager< MDTraits >::init ( std::shared_ptr< Problem< rotationIdx > >  momentumProblem,
std::shared_ptr< Problem< deformationIdx > >  massProblem,
const SolutionVector &  curSol 
)
inlineinherited

◆ numericEpsilon()

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

◆ problem()

const Problem< i > & Dumux::CouplingManager< MDTraits >::problem ( Dune::index_constant< i >  domainIdx) const
inlineinherited
Parameters
domainIdxThe domain index We avoid exception handling here because the performance of this function is critical

◆ rotation()

template<class MDTraits >
auto Dumux::KirchhoffLovePlateCouplingManager< MDTraits >::rotation ( typename GridGeometry< deformationIdx >::LocalView const &  fvGeometry,
typename GridGeometry< deformationIdx >::SubControlVolumeFace const &  scvf 
) const
inlineinherited

◆ setSubProblem()

void Dumux::CouplingManager< MDTraits >::setSubProblem ( std::shared_ptr< SubProblem >  problem,
Dune::index_constant< i >  domainIdx 
)
inlineinherited
Parameters
problema pointer to the sub problem
domainIdxthe domain index of the sub problem

◆ setSubProblems()

void Dumux::CouplingManager< MDTraits >::setSubProblems ( const std::tuple< std::shared_ptr< SubProblems >... > &  problems)
inlineinherited
Parameters
problemsA tuple of shared pointers to the sub problems

◆ shearCurlPotentialIdx()

template<class MDTraits >
auto Dumux::KirchhoffLovePlateCouplingManager< MDTraits >::shearCurlPotentialIdx ( ) const
inlineinherited

◆ shearGradPotentialIdx()

template<class MDTraits >
auto Dumux::KirchhoffLovePlateCouplingManager< MDTraits >::shearGradPotentialIdx ( ) const
inlineinherited

◆ updateCoupledVariables() [1/2]

void Dumux::CouplingManager< MDTraits >::updateCoupledVariables ( Dune::index_constant< i >  domainI,
const LocalAssemblerI &  localAssemblerI,
UpdatableElementVars &  elemVars 
)
inlineinherited
Parameters
domainIthe index of domain i
localAssemblerIthe local assembler assembling the element residual of an element of domain i
elemVarsthe 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
domainIthe index of domain i
localAssemblerIthe local assembler assembling the element residual of an element of domain i
elemVarsthe element variables (all variables in the element local stencil) to be updated
elemFluxVarsCachethe 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
domainIthe domain index of domain i
localAssemblerIthe local assembler assembling the element residual of an element of domain i
domainJthe domain index of domain j
dofIdxGlobalJthe index of the degree of freedom of domain j whose solution changed
priVarsJthe new solution at the degree of freedom of domain j with index dofIdxGlobalJ
pvIdxJthe 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

◆ deformationIdx

template<class MDTraits >
constexpr auto Dumux::KirchhoffLovePlateCouplingManager< MDTraits >::deformationIdx = typename MDTraits::template SubDomain<1>::Index()
staticconstexprinherited

◆ rotationIdx

template<class MDTraits >
constexpr auto Dumux::KirchhoffLovePlateCouplingManager< MDTraits >::rotationIdx = typename MDTraits::template SubDomain<0>::Index()
staticconstexprinherited

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