DUNE-ACFEM (unstable)

Dune::ACFem::PDEModel::BulkLoadFunctionModel< GridFunction > Class Template Reference

Wrap an existing GridFunction into a model which only conatains this ModelConstituent. More...

#include <dune/acfem/models/modules/bulkloadmodel.hh>

+ Collaboration diagram for Dune::ACFem::PDEModel::BulkLoadFunctionModel< GridFunction >:

Public Member Functions

template<class Entity >
void bind (const Entity &entity)
 
void unbind ()
 
template<class Quadrature >
RangeType source (const QuadraturePoint< Quadrature > &x) const
 

FunctionSpaceTypes

Forward some basic type from the supplied function-spaces to the model class.

Note that FunctionSpace is defined as a shortcut for RangeFunctionSpace in order to simplify the common case DomainFunctionSpace == RangeFunctionSpace.

auto classifyBoundary (const Intersection &intersection)
 Bind to the given intersection and classify the components w.r.t. More...
 
using HessianRangeSelector = typename std::conditional< std::is_convertible< typename FunctionSpace::RangeType, typename FunctionSpace::HessianRangeType >::value, Fem::ExplicitFieldVector< typename FunctionSpace::HessianRangeType::value_type, FunctionSpace::dimRange >, typename FunctionSpace::HessianRangeType >::type
 The type returned by classifyBoundary().
 
using RangeFunctionSpaceType = std::decay_t< GridFunction >::FunctionSpaceType
 The type returned by classifyBoundary().
 
using DomainFunctionSpaceType = std::decay_t< GridFunction >::FunctionSpaceType
 The type returned by classifyBoundary().
 
using FunctionSpaceType = RangeFunctionSpaceType
 The type returned by classifyBoundary().
 
using DomainType = typename FunctionSpaceType::DomainType
 The type returned by classifyBoundary().
 
using JacobianRangeType = typename FunctionSpaceType::JacobianRangeType
 The type returned by classifyBoundary().
 
using HessianRangeType = HessianRangeSelector< FunctionSpaceType >
 The type returned by classifyBoundary().
 
using DomainFieldType = typename FunctionSpaceType::DomainFieldType
 The type returned by classifyBoundary().
 
using RangeFieldType = typename FunctionSpaceType::RangeFieldType
 The type returned by classifyBoundary().
 
using DomainRangeType = typename DomainFunctionSpaceType::RangeType
 The type returned by classifyBoundary().
 
using DomainDomainType = typename DomainFunctionSpaceType::DomainType
 The type returned by classifyBoundary().
 
using DomainJacobianRangeType = typename DomainFunctionSpaceType::JacobianRangeType
 The type returned by classifyBoundary().
 
using DomainHessianRangeType = HessianRangeSelector< DomainFunctionSpaceType >
 The type returned by classifyBoundary().
 
using DomainDomainFieldType = typename DomainFunctionSpaceType::DomainFieldType
 The type returned by classifyBoundary().
 
using DomainRangeFieldType = typename DomainFunctionSpaceType::RangeFieldType
 The type returned by classifyBoundary().
 
using RangeRangeType = typename RangeFunctionSpaceType::RangeType
 The type returned by classifyBoundary().
 
using RangeDomainType = typename RangeFunctionSpaceType::DomainType
 The type returned by classifyBoundary().
 
using RangeJacobianRangeType = typename RangeFunctionSpaceType::JacobianRangeType
 The type returned by classifyBoundary().
 
using RangeHessianRangeType = HessianRangeSelector< RangeFunctionSpaceType >
 The type returned by classifyBoundary().
 
using RangeDomainFieldType = typename RangeFunctionSpaceType::DomainFieldType
 The type returned by classifyBoundary().
 
using RangeRangeFieldType = typename RangeFunctionSpaceType::RangeFieldType
 The type returned by classifyBoundary().
 
using BoundaryConditionsType = std::pair< bool, std::bitset< dimRange > >
 The type returned by classifyBoundary().
 
static constexpr int dimDomain
 The type returned by classifyBoundary().
 
static constexpr int dimRange
 The type returned by classifyBoundary().
 
static constexpr int domainDimDomain
 The type returned by classifyBoundary().
 
static constexpr int domainDimRange
 
static constexpr int rangeDimDomain
 The type returned by classifyBoundary().
 
static constexpr int rangeDimRange
 

Detailed Description

template<class GridFunction>
class Dune::ACFem::PDEModel::BulkLoadFunctionModel< GridFunction >

Wrap an existing GridFunction into a model which only conatains this ModelConstituent.

The most convenient way to add a grid-function to the "right-hande-side" of a model is the use of algebraic expressions:

MyGridFunctionObject F;
auto newModel = existingModel - F;

The underlying expression-templates will form a suitable BulkLoadFunctionModel by means of the overloaded operator-() function and add that to the existing model.

Member Function Documentation

◆ classifyBoundary()

auto Dune::ACFem::ModelBase< std::decay_t< GridFunction >::FunctionSpaceType , std::decay_t< GridFunction >::FunctionSpaceType >::classifyBoundary ( const Intersection &  intersection)
inlineinherited

Bind to the given intersection and classify the components w.r.t.

to the kind of applicable boundary conditions.

Warning
Note that prior to calling this function the model has to be bound to the inside entity of the given intersection. Failing to do so generates undefined behaviour.
The result of calling the other boundary related methods without binding to an intersection is undefined.
If RESULT.first is false, then the result of calling any of the other boundary related functions is undefined. Philosophically, they should return 0 in this case, but in order to have decent performance they give a damn and just don't care.
If RESULT.first is true, then still you cannot rely on user-friendly behaviour:
  • only if the respective bit of RESULT.second is set to 1, then the Dirichlet value in this compoment is well-defined.
  • only if the respective bit of RESULT.second is set to 0, then the Robin value in this component is well defined.
Parameters
[in]intersectionThe intersection to bind to.
Returns
A tuple. First component is a bool which is true iff any of the boundary related data functions would result in non trivial results. Second component is a bitset of size dimRange which is true if the given component of the system is subject to Dirichlet boundary conditions and false if it is subject to Robin or Neumann boundary conditions. If first is false then the contents of the bitset is undefined.

Member Data Documentation

◆ domainDimRange

constexpr int Dune::ACFem::ModelBase< std::decay_t< GridFunction >::FunctionSpaceType , std::decay_t< GridFunction >::FunctionSpaceType >::domainDimRange
staticconstexprinherited

◆ rangeDimRange

constexpr int Dune::ACFem::ModelBase< std::decay_t< GridFunction >::FunctionSpaceType , std::decay_t< GridFunction >::FunctionSpaceType >::rangeDimRange
staticconstexprinherited

The documentation for this class was generated from the following file:
Creative Commons License   |  Legal Statements / Impressum  |  Hosted by TU Dresden  |  generated with Hugo v0.80.0 (Apr 21, 22:30, 2024)