3.5-git
DUNE for Multi-{Phase, Component, Scale, Physics, ...} flow and transport in porous media
Public Types | Public Member Functions | Static Public Attributes | Protected Types | Protected Member Functions | Protected Attributes | List of all members
Dumux::Embedded1d3dCouplingManager< MDTraits, Embedded1d3dCouplingMode::Kernel > Class Template Reference

Manages the coupling between bulk elements and lower dimensional elements Point sources on each integration point are computed by an AABB tree. More...

#include <dumux/multidomain/embedded/couplingmanager1d3d_kernel.hh>

Inheritance diagram for Dumux::Embedded1d3dCouplingManager< MDTraits, Embedded1d3dCouplingMode::Kernel >:

Description

template<class MDTraits>
class Dumux::Embedded1d3dCouplingManager< MDTraits, Embedded1d3dCouplingMode::Kernel >

Manages the coupling between bulk elements and lower dimensional elements Point sources on each integration point are computed by an AABB tree.

Note
Specialization for coupling method using a distributed kernel source with 3d quantities evaluated on the line

Public Types

using MultiDomainTraits = MDTraits
 export traits More...
 
using PointSourceTraits = DefaultPointSourceTraits< MDTraits >
 export the point source traits More...
 
using CouplingStencils = std::unordered_map< GridIndex< id >, CouplingStencil< id > >
 export stencil types 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< bulkIdx > > bulkProblem, std::shared_ptr< Problem< lowDimIdx > > lowDimProblem, const SolutionVector &curSol)
 
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...
 
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 &, 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 (per default this is not the case) More...
 
void computePointSourceData (std::size_t order=1, bool verbose=false)
 
void computeLowDimVolumeFractions ()
 Compute the low dim volume fraction in the bulk domain cells. More...
 
Scalar radius (std::size_t id) const
 Methods to be accessed by the subproblems. More...
 
Scalar lowDimVolume (const Element< bulkIdx > &element) const
 The volume the lower dimensional domain occupies in the bulk domain element. More...
 
Scalar lowDimVolumeFraction (const Element< bulkIdx > &element) const
 The volume fraction the lower dimensional domain occupies in the bulk domain element. More...
 
const std::vector< std::size_t > & bulkSourceIds (GridIndex< bulkIdx > eIdx, int scvIdx=0) const
 return all source ids for a bulk elements More...
 
const std::vector< Scalar > & bulkSourceWeights (GridIndex< bulkIdx > eIdx, int scvIdx=0) const
 return all source ids for a bulk elements More...
 
Scalar fluxScalingFactor (std::size_t id) const
 The flux scaling factor for a source with id. More...
 
void updateAfterGridAdaption (std::shared_ptr< const GridGeometry< bulkIdx > > bulkGridGeometry, std::shared_ptr< const GridGeometry< lowDimIdx > > lowDimGridGeometry)
 call this after grid adaption More...
 
void init (std::shared_ptr< Problem< bulkIdx > > bulkProblem, std::shared_ptr< Problem< lowDimIdx > > lowDimProblem, const SolutionVector &curSol)
 Methods to be accessed by main. More...
 
const CouplingStencil< j > & couplingStencil (Dune::index_constant< i > domainI, const Element< i > &element, Dune::index_constant< j > domainJ) const
 Methods to be accessed by the assembly. More...
 
decltype(auto) evalCouplingResidual (Dune::index_constant< i > domainI, const LocalAssemblerI &localAssemblerI, Dune::index_constant< j > domainJ, std::size_t dofIdxGlobalJ)
 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...
 
const PointSourceData & pointSourceData (std::size_t id) const
 Methods to be accessed by the subproblems. More...
 
const std::vector< PointSourceData > & pointSourceData () const
 Return reference to point source data vector member. More...
 
const GridView< id > & gridView (Dune::index_constant< id > domainIdx) const
 Return a reference to the bulk problem. More...
 
PrimaryVariables< bulkIdx > bulkPriVars (std::size_t id) const
 Return data for a bulk point source with the identifier id. More...
 
PrimaryVariables< lowDimIdx > lowDimPriVars (std::size_t id) const
 Return data for a low dim point source with the identifier id. More...
 
Scalar averageDistance (std::size_t id) const
 return the average distance to the coupled bulk cell center More...
 
const std::vector< PointSource< bulkIdx > > & bulkPointSources () const
 Return reference to bulk point sources. More...
 
const std::vector< PointSource< lowDimIdx > > & lowDimPointSources () const
 Return reference to low dim point sources. More...
 
const std::vector< PointSource< i > > & pointSources (Dune::index_constant< i > dom) const
 Return the point source if domain i. More...
 
const CouplingStencils< i > & couplingStencils (Dune::index_constant< i > dom) const
 Return reference to bulk coupling stencil member of domain i. More...
 
const CouplingStencil< i > & emptyStencil (Dune::index_constant< i > dom) const
 Return a reference to an empty stencil. More...
 
auto & curSol (Dune::index_constant< i > domainIdx)
 the solution vector of the subproblem More...
 
const auto & curSol (Dune::index_constant< i > domainIdx) const
 the solution vector of the subproblem More...
 

Static Public Attributes

static constexpr Embedded1d3dCouplingMode::Kernel couplingMode {}
 

Protected Types

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

Protected Member Functions

std::vector< PointSourceData > & pointSourceData ()
 Return reference to point source data vector member. More...
 
std::vector< PointSource< i > > & pointSources (Dune::index_constant< i > dom)
 Return the point source if domain i. More...
 
CouplingStencils< i > & couplingStencils (Dune::index_constant< i > dom)
 Return reference to bulk coupling stencil member of domain i. More...
 
void precomputeVertexIndices (Dune::index_constant< id > domainIdx)
 computes the vertex indices per element for the box method More...
 
void getShapeValues (Dune::index_constant< i > domainI, const FVGG &gridGeometry, const Geometry &geo, const GlobalPosition &globalPos, ShapeValues &shapeValues)
 compute the shape function for a given point and geometry More...
 
void clear ()
 Clear all internal data members. More...
 
void glueGrids ()
 compute the intersections between the two grids More...
 
std::vector< Scalar > & averageDistanceToBulkCell ()
 Return reference to average distances to bulk cell. More...
 
std::vector< GridIndex< i > > & vertexIndices (Dune::index_constant< i > dom, GridIndex< i > eIdx)
 Return a reference to the vertex indices. More...
 
std::vector< std::vector< GridIndex< i > > > & vertexIndices (Dune::index_constant< i > dom)
 Return a reference to the vertex indices container. More...
 
const GlueTypeglue () const
 
Embedded1d3dCouplingManager< MDTraits, Embedded1d3dCouplingMode::Kernel > & asImp_ ()
 Returns the implementation of the problem (i.e. static polymorphism) More...
 
const Embedded1d3dCouplingManager< MDTraits, Embedded1d3dCouplingMode::Kernel > & asImp_ () const
 Returns the implementation of the problem (i.e. static polymorphism) More...
 

Protected Attributes

std::size_t idCounter_
 id generator for point sources More...
 

member functions concerning variable caching for element residual evaluations

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 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) 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...
 
decltype(auto) curSol ()
 the solution vector of the coupled problem More...
 
decltype(auto) curSol () const
 the solution vector of the coupled problem More...
 
void attachSolution (SolutionVectorStorage &curSol)
 Attach a solution vector stored outside of this class. More...
 

Member Typedef Documentation

◆ CouplingStencils

using Dumux::EmbeddedCouplingManagerBase< MDTraits, Embedded1d3dCouplingManager< MDTraits, Embedded1d3dCouplingMode::Kernel > , DefaultPointSourceTraits<MDTraits> >::CouplingStencils = std::unordered_map<GridIndex<id>, CouplingStencil<id> >
inherited

export stencil types

◆ CouplingStencilType

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

default type used for coupling element stencils

◆ MultiDomainTraits

using Dumux::EmbeddedCouplingManagerBase< MDTraits, Embedded1d3dCouplingManager< MDTraits, Embedded1d3dCouplingMode::Kernel > , DefaultPointSourceTraits<MDTraits> >::MultiDomainTraits = MDTraits
inherited

export traits

◆ PointSourceTraits

export the point source traits

◆ SolutionVectorStorage

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

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

Member Function Documentation

◆ asImp_() [1/2]

Returns the implementation of the problem (i.e. static polymorphism)

◆ asImp_() [2/2]

Returns the implementation of the problem (i.e. static polymorphism)

◆ 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.

◆ averageDistance()

Scalar Dumux::EmbeddedCouplingManagerBase< MDTraits, Embedded1d3dCouplingManager< MDTraits, Embedded1d3dCouplingMode::Kernel > , DefaultPointSourceTraits<MDTraits> >::averageDistance ( std::size_t  id) const
inlineinherited

return the average distance to the coupled bulk cell center

◆ averageDistanceToBulkCell()

std::vector< Scalar > & Dumux::EmbeddedCouplingManagerBase< MDTraits, Embedded1d3dCouplingManager< MDTraits, Embedded1d3dCouplingMode::Kernel > , DefaultPointSourceTraits<MDTraits> >::averageDistanceToBulkCell ( )
inlineprotectedinherited

Return reference to average distances to bulk cell.

◆ 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
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

◆ bulkPointSources()

const std::vector< PointSource< bulkIdx > > & Dumux::EmbeddedCouplingManagerBase< MDTraits, Embedded1d3dCouplingManager< MDTraits, Embedded1d3dCouplingMode::Kernel > , DefaultPointSourceTraits<MDTraits> >::bulkPointSources ( ) const
inlineinherited

Return reference to bulk point sources.

◆ bulkPriVars()

PrimaryVariables< bulkIdx > Dumux::EmbeddedCouplingManagerBase< MDTraits, Embedded1d3dCouplingManager< MDTraits, Embedded1d3dCouplingMode::Kernel > , DefaultPointSourceTraits<MDTraits> >::bulkPriVars ( std::size_t  id) const
inlineinherited

Return data for a bulk point source with the identifier id.

◆ bulkSourceIds()

template<class MDTraits >
const std::vector< std::size_t > & Dumux::Embedded1d3dCouplingManager< MDTraits, Embedded1d3dCouplingMode::Kernel >::bulkSourceIds ( GridIndex< bulkIdx >  eIdx,
int  scvIdx = 0 
) const
inline

return all source ids for a bulk elements

◆ bulkSourceWeights()

template<class MDTraits >
const std::vector< Scalar > & Dumux::Embedded1d3dCouplingManager< MDTraits, Embedded1d3dCouplingMode::Kernel >::bulkSourceWeights ( GridIndex< bulkIdx >  eIdx,
int  scvIdx = 0 
) const
inline

return all source ids for a bulk elements

◆ clear()

void Dumux::EmbeddedCouplingManagerBase< MDTraits, Embedded1d3dCouplingManager< MDTraits, Embedded1d3dCouplingMode::Kernel > , DefaultPointSourceTraits<MDTraits> >::clear ( )
inlineprotectedinherited

Clear all internal data members.

◆ computeLowDimVolumeFractions()

template<class MDTraits >
void Dumux::Embedded1d3dCouplingManager< MDTraits, Embedded1d3dCouplingMode::Kernel >::computeLowDimVolumeFractions ( )
inline

Compute the low dim volume fraction in the bulk domain cells.

◆ computePointSourceData()

template<class MDTraits >
void Dumux::Embedded1d3dCouplingManager< MDTraits, Embedded1d3dCouplingMode::Kernel >::computePointSourceData ( std::size_t  order = 1,
bool  verbose = false 
)
inline

◆ couplingStencil()

const CouplingStencil< j > & Dumux::EmbeddedCouplingManagerBase< MDTraits, Embedded1d3dCouplingManager< MDTraits, Embedded1d3dCouplingMode::Kernel > , DefaultPointSourceTraits<MDTraits> >::couplingStencil ( Dune::index_constant< i >  domainI,
const Element< i > &  element,
Dune::index_constant< j >  domainJ 
) const
inlineinherited

Methods to be accessed by the assembly.

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
domainIthe domain index of domain i
elementthe coupled element of domain í
domainJthe 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

◆ couplingStencils() [1/2]

CouplingStencils< i > & Dumux::EmbeddedCouplingManagerBase< MDTraits, Embedded1d3dCouplingManager< MDTraits, Embedded1d3dCouplingMode::Kernel > , DefaultPointSourceTraits<MDTraits> >::couplingStencils ( Dune::index_constant< i >  dom)
inlineprotectedinherited

Return reference to bulk coupling stencil member of domain i.

◆ couplingStencils() [2/2]

const CouplingStencils< i > & Dumux::EmbeddedCouplingManagerBase< MDTraits, Embedded1d3dCouplingManager< MDTraits, Embedded1d3dCouplingMode::Kernel > , DefaultPointSourceTraits<MDTraits> >::couplingStencils ( Dune::index_constant< i >  dom) const
inlineinherited

Return reference to bulk coupling stencil member of domain i.

◆ curSol() [1/4]

decltype(auto) Dumux::CouplingManager< MDTraits >::curSol ( )
inlineprotectedinherited

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]

decltype(auto) Dumux::CouplingManager< MDTraits >::curSol ( ) const
inlineprotectedinherited

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]

auto & Dumux::EmbeddedCouplingManagerBase< MDTraits, Embedded1d3dCouplingManager< MDTraits, Embedded1d3dCouplingMode::Kernel > , DefaultPointSourceTraits<MDTraits> >::curSol ( Dune::index_constant< i >  domainIdx)
inlineinherited

the solution vector of the subproblem

Parameters
domainIdxThe domain index
Note
in case of numeric differentiation the solution vector always carries the deflected solution

◆ curSol() [4/4]

const auto & Dumux::EmbeddedCouplingManagerBase< MDTraits, Embedded1d3dCouplingManager< MDTraits, Embedded1d3dCouplingMode::Kernel > , DefaultPointSourceTraits<MDTraits> >::curSol ( Dune::index_constant< i >  domainIdx) const
inlineinherited

the solution vector of the subproblem

Parameters
domainIdxThe domain index
Note
in case of numeric differentiation the solution vector always carries the deflected solution

◆ emptyStencil()

const CouplingStencil< i > & Dumux::EmbeddedCouplingManagerBase< MDTraits, Embedded1d3dCouplingManager< MDTraits, Embedded1d3dCouplingMode::Kernel > , DefaultPointSourceTraits<MDTraits> >::emptyStencil ( Dune::index_constant< i >  dom) const
inlineinherited

Return a reference to an empty stencil.

◆ evalAdditionalDomainDerivatives()

template<class MDTraits >
template<std::size_t i, class LocalAssemblerI , class JacobianMatrixDiagBlock , class GridVariables >
void Dumux::Embedded1d3dCouplingManager< MDTraits, Embedded1d3dCouplingMode::Kernel >::evalAdditionalDomainDerivatives ( Dune::index_constant< i >  domainI,
const LocalAssemblerI &  localAssemblerI,
const typename LocalAssemblerI::LocalResidual::ElementResidualVector &  ,
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 (per default this is not the case)

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
This is the same for box and cc

◆ evalCouplingResidual() [1/2]

decltype(auto) Dumux::EmbeddedCouplingManagerBase< MDTraits, Embedded1d3dCouplingManager< MDTraits, Embedded1d3dCouplingMode::Kernel > , DefaultPointSourceTraits<MDTraits> >::evalCouplingResidual ( Dune::index_constant< i >  domainI,
const LocalAssemblerI &  localAssemblerI,
Dune::index_constant< j >  domainJ,
std::size_t  dofIdxGlobalJ 
)
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
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
we only need to evaluate the source contribution to the residual here as the coupling term is the source
Returns
the element residual

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

template<class MDTraits >
template<std::size_t id, class JacobianPattern >
void Dumux::Embedded1d3dCouplingManager< MDTraits, Embedded1d3dCouplingMode::Kernel >::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
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

◆ fluxScalingFactor()

template<class MDTraits >
Scalar Dumux::Embedded1d3dCouplingManager< MDTraits, Embedded1d3dCouplingMode::Kernel >::fluxScalingFactor ( std::size_t  id) const
inline

The flux scaling factor for a source with id.

◆ getShapeValues()

void Dumux::EmbeddedCouplingManagerBase< MDTraits, Embedded1d3dCouplingManager< MDTraits, Embedded1d3dCouplingMode::Kernel > , DefaultPointSourceTraits<MDTraits> >::getShapeValues ( Dune::index_constant< i >  domainI,
const FVGG &  gridGeometry,
const Geometry &  geo,
const GlobalPosition &  globalPos,
ShapeValues &  shapeValues 
)
inlineprotectedinherited

compute the shape function for a given point and geometry

◆ glue()

const GlueType & Dumux::EmbeddedCouplingManagerBase< MDTraits, Embedded1d3dCouplingManager< MDTraits, Embedded1d3dCouplingMode::Kernel > , DefaultPointSourceTraits<MDTraits> >::glue ( ) const
inlineprotectedinherited

◆ glueGrids()

void Dumux::EmbeddedCouplingManagerBase< MDTraits, Embedded1d3dCouplingManager< MDTraits, Embedded1d3dCouplingMode::Kernel > , DefaultPointSourceTraits<MDTraits> >::glueGrids ( )
inlineprotectedinherited

compute the intersections between the two grids

◆ gridView()

const GridView< id > & Dumux::EmbeddedCouplingManagerBase< MDTraits, Embedded1d3dCouplingManager< MDTraits, Embedded1d3dCouplingMode::Kernel > , DefaultPointSourceTraits<MDTraits> >::gridView ( Dune::index_constant< id >  domainIdx) const
inlineinherited

Return a reference to the bulk problem.

◆ init() [1/2]

template<class MDTraits >
void Dumux::Embedded1d3dCouplingManager< MDTraits, Embedded1d3dCouplingMode::Kernel >::init ( std::shared_ptr< Problem< bulkIdx > >  bulkProblem,
std::shared_ptr< Problem< lowDimIdx > >  lowDimProblem,
const SolutionVector &  curSol 
)
inline

◆ init() [2/2]

void Dumux::EmbeddedCouplingManagerBase< MDTraits, Embedded1d3dCouplingManager< MDTraits, Embedded1d3dCouplingMode::Kernel > , DefaultPointSourceTraits<MDTraits> >::init ( std::shared_ptr< Problem< bulkIdx > >  bulkProblem,
std::shared_ptr< Problem< lowDimIdx > >  lowDimProblem,
const SolutionVector curSol 
)
inlineinherited

Methods to be accessed by main.

◆ lowDimPointSources()

const std::vector< PointSource< lowDimIdx > > & Dumux::EmbeddedCouplingManagerBase< MDTraits, Embedded1d3dCouplingManager< MDTraits, Embedded1d3dCouplingMode::Kernel > , DefaultPointSourceTraits<MDTraits> >::lowDimPointSources ( ) const
inlineinherited

Return reference to low dim point sources.

◆ lowDimPriVars()

PrimaryVariables< lowDimIdx > Dumux::EmbeddedCouplingManagerBase< MDTraits, Embedded1d3dCouplingManager< MDTraits, Embedded1d3dCouplingMode::Kernel > , DefaultPointSourceTraits<MDTraits> >::lowDimPriVars ( std::size_t  id) const
inlineinherited

Return data for a low dim point source with the identifier id.

◆ lowDimVolume()

template<class MDTraits >
Scalar Dumux::Embedded1d3dCouplingManager< MDTraits, Embedded1d3dCouplingMode::Kernel >::lowDimVolume ( const Element< bulkIdx > &  element) const
inline

The volume the lower dimensional domain occupies in the bulk domain element.

◆ lowDimVolumeFraction()

template<class MDTraits >
Scalar Dumux::Embedded1d3dCouplingManager< MDTraits, Embedded1d3dCouplingMode::Kernel >::lowDimVolumeFraction ( const Element< bulkIdx > &  element) const
inline

The volume fraction the lower dimensional domain occupies in the bulk domain element.

◆ numericEpsilon()

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

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

◆ pointSourceData() [1/3]

std::vector< PointSourceData > & Dumux::EmbeddedCouplingManagerBase< MDTraits, Embedded1d3dCouplingManager< MDTraits, Embedded1d3dCouplingMode::Kernel > , DefaultPointSourceTraits<MDTraits> >::pointSourceData ( )
inlineprotectedinherited

Return reference to point source data vector member.

◆ pointSourceData() [2/3]

const std::vector< PointSourceData > & Dumux::EmbeddedCouplingManagerBase< MDTraits, Embedded1d3dCouplingManager< MDTraits, Embedded1d3dCouplingMode::Kernel > , DefaultPointSourceTraits<MDTraits> >::pointSourceData ( ) const
inlineinherited

Return reference to point source data vector member.

◆ pointSourceData() [3/3]

const PointSourceData & Dumux::EmbeddedCouplingManagerBase< MDTraits, Embedded1d3dCouplingManager< MDTraits, Embedded1d3dCouplingMode::Kernel > , DefaultPointSourceTraits<MDTraits> >::pointSourceData ( std::size_t  id) const
inlineinherited

Methods to be accessed by the subproblems.

Return a reference to the pointSource data

◆ pointSources() [1/2]

std::vector< PointSource< i > > & Dumux::EmbeddedCouplingManagerBase< MDTraits, Embedded1d3dCouplingManager< MDTraits, Embedded1d3dCouplingMode::Kernel > , DefaultPointSourceTraits<MDTraits> >::pointSources ( Dune::index_constant< i >  dom)
inlineprotectedinherited

Return the point source if domain i.

◆ pointSources() [2/2]

const std::vector< PointSource< i > > & Dumux::EmbeddedCouplingManagerBase< MDTraits, Embedded1d3dCouplingManager< MDTraits, Embedded1d3dCouplingMode::Kernel > , DefaultPointSourceTraits<MDTraits> >::pointSources ( Dune::index_constant< i >  dom) const
inlineinherited

Return the point source if domain i.

◆ precomputeVertexIndices()

void Dumux::EmbeddedCouplingManagerBase< MDTraits, Embedded1d3dCouplingManager< MDTraits, Embedded1d3dCouplingMode::Kernel > , DefaultPointSourceTraits<MDTraits> >::precomputeVertexIndices ( Dune::index_constant< id >  domainIdx)
inlineprotectedinherited

computes the vertex indices per element for the box method

◆ problem()

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

Return a reference to the sub problem.

Parameters
domainIdxThe domain index We avoid exception handling here because the performance of this function is critical

◆ radius()

template<class MDTraits >
Scalar Dumux::Embedded1d3dCouplingManager< MDTraits, Embedded1d3dCouplingMode::Kernel >::radius ( std::size_t  id) const
inline

Methods to be accessed by the subproblems.

Return a reference to the bulk problem

◆ 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
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

set the pointers to the sub problems

Parameters
problemsA tuple of shared pointers to the sub problems

◆ updateAfterGridAdaption()

void Dumux::EmbeddedCouplingManagerBase< MDTraits, Embedded1d3dCouplingManager< MDTraits, Embedded1d3dCouplingMode::Kernel > , DefaultPointSourceTraits<MDTraits> >::updateAfterGridAdaption ( std::shared_ptr< const GridGeometry< bulkIdx > >  bulkGridGeometry,
std::shared_ptr< const GridGeometry< lowDimIdx > >  lowDimGridGeometry 
)
inlineinherited

call this after grid adaption

◆ 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
domainIthe index of domain i
localAssemblerIthe local assembler assembling the element residual of an element of domain i
elemVolVarsthe element volume variables (all volume 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 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)

◆ 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

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
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 udpate 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.

◆ vertexIndices() [1/2]

std::vector< std::vector< GridIndex< i > > > & Dumux::EmbeddedCouplingManagerBase< MDTraits, Embedded1d3dCouplingManager< MDTraits, Embedded1d3dCouplingMode::Kernel > , DefaultPointSourceTraits<MDTraits> >::vertexIndices ( Dune::index_constant< i >  dom)
inlineprotectedinherited

Return a reference to the vertex indices container.

◆ vertexIndices() [2/2]

std::vector< GridIndex< i > > & Dumux::EmbeddedCouplingManagerBase< MDTraits, Embedded1d3dCouplingManager< MDTraits, Embedded1d3dCouplingMode::Kernel > , DefaultPointSourceTraits<MDTraits> >::vertexIndices ( Dune::index_constant< i >  dom,
GridIndex< i >  eIdx 
)
inlineprotectedinherited

Return a reference to the vertex indices.

Member Data Documentation

◆ couplingMode

template<class MDTraits >
constexpr Embedded1d3dCouplingMode::Kernel Dumux::Embedded1d3dCouplingManager< MDTraits, Embedded1d3dCouplingMode::Kernel >::couplingMode {}
staticconstexpr

◆ idCounter_

std::size_t Dumux::EmbeddedCouplingManagerBase< MDTraits, Embedded1d3dCouplingManager< MDTraits, Embedded1d3dCouplingMode::Kernel > , DefaultPointSourceTraits<MDTraits> >::idCounter_
protectedinherited

id generator for point sources


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