DUNE-ACFEM (2.5.1)

Dune::ACFem::BulkForcesFunctionModel< GridFunction > Struct Template Reference

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

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

+ Collaboration diagram for Dune::ACFem::BulkForcesFunctionModel< GridFunction >:

Public Types

typedef Expression ExpressionType
 The type of the underlying expression.
 
BOUNDARY_INDICATORS
typedef DefaultTraitsType::DirichletIndicatorType DirichletIndicatorType
 
typedef DefaultTraitsType::NeumannIndicatorType NeumannIndicatorType
 

Public Member Functions

BulkForcesFunctionType bulkForcesFunction (const GridPartType &gridPart) const
 
TraitsType::template ForcesFunctionalTraits< DiscreteFunctionSpace >::FunctionalType forcesFunctional (const DiscreteFunctionSpace &space) const
 
DirichletBoundaryFunctionType dirichletBoundaryFunction (const GridPartType &gridPart) const
 
DirichletWeightFunctionType dirichletWeightFunction (const GridPartType &gridPart) const
 
NeumannBoundaryFunctionType neumannBoundaryFunction (const GridPartType &gridPart) const
 
DirichletIndicatorType dirichletIndicator () const
 
NeumannIndicatorType neumannIndicator () const
 
const ExpressionTypeexpression () const
 Return a const reference to the underlying expression.
 
ExpressionTypeexpression ()
 Return a mutable reference to the underlying expression.
 
ExpressionType operator* () const
 Return a copy from of the underlying expression.
 

Detailed Description

template<class GridFunction>
struct Dune::ACFem::BulkForcesFunctionModel< 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 BulkForcesFunctionModel by means of the overloaded operator-() function and add that to the existing model.

Member Function Documentation

◆ bulkForcesFunction()

BulkForcesFunctionType Dune::ACFem::DefaultModel< Expression >::bulkForcesFunction ( const GridPartType &  gridPart) const
inlineinherited

Generate an instance of a class defining the bulk-forces the model is subject to.

The return object is a Fem grid-function. This can be used for the case where the "right hand side" is an L2-function.

◆ dirichletBoundaryFunction()

DirichletBoundaryFunctionType Dune::ACFem::DefaultModel< Expression >::dirichletBoundaryFunction ( const GridPartType &  gridPart) const
inlineinherited

Generate an instance of a class defining Dirichlet boundary values as a Fem grid-function.

◆ dirichletIndicator()

DirichletIndicatorType Dune::ACFem::DefaultModel< Expression >::dirichletIndicator ( ) const
inlineinherited

Generate an object to identify parts of the boundary subject to Dirichlet boundary conditions.

The return value has to obey the BoundaryIndicatorInterface.

◆ dirichletWeightFunction()

DirichletWeightFunctionType Dune::ACFem::DefaultModel< Expression >::dirichletWeightFunction ( const GridPartType &  gridPart) const
inlineinherited

Generate an instance of a class defining a "left hand side" weight on the Dirichlet boundary conditions, DefaultModelTraits::DirichletWeightFunctionType.

◆ forcesFunctional()

TraitsType::template ForcesFunctionalTraits< DiscreteFunctionSpace >::FunctionalType Dune::ACFem::DefaultModel< Expression >::forcesFunctional ( const DiscreteFunctionSpace &  space) const
inlineinherited

Generate an instance of a class defining a functional which forms part of the force-terms for the model.

◆ neumannBoundaryFunction()

NeumannBoundaryFunctionType Dune::ACFem::DefaultModel< Expression >::neumannBoundaryFunction ( const GridPartType &  gridPart) const
inlineinherited

Generate an instance of a class defining Neumann boundary values as a Fem grid-function.

◆ neumannIndicator()

NeumannIndicatorType Dune::ACFem::DefaultModel< Expression >::neumannIndicator ( ) const
inlineinherited

Generate an object to identify parts of the boundary subject to Neumann boundary conditions.

The return value has to obey the BoundaryIndicatorInterface.


The documentation for this struct was generated from the following file:
Creative Commons License   |  Legal Statements / Impressum  |  Hosted by TU Dresden  |  generated with Hugo v0.111.3 (Nov 12, 23:30, 2024)