Dune::PDELab::DirichletConstraintsParameters Struct Reference

#include <dune/pdelab/constraints/common/constraintsparameters.hh>

Public Types
typedef LeafNodeTag	NodeTag
	The type tag that describes a LeafNode.

Public Member Functions
template<typename I >
bool	isDirichlet (const I &intersection, const FieldVector< typename I::ctype, I::mydimension > &coord) const
template<typename I >
bool	isNeumann (const I &intersection, const FieldVector< typename I::ctype, I::mydimension > &coord) const
template<typename T >
void	setTime (const T &time)

Static Public Attributes
static const bool	isLeaf = true
	Mark this class as a leaf in a dune-typetree.
static const bool	isPower = false
	Mark this class as a non power in the dune-typetree.
static const bool	isComposite = false
	Mark this class as a non composite in the dune-typetree.

Detailed Description

Interface for the constraints parameters describing Dirichlet constraints.

Note

This class not only describes the required interface of the parameter class, but can also be used as a convenient standard implementation that will add Dirichlet constraints to all locations it is queried about.

Member Function Documentation

isDirichlet()

template<typename I >

bool Dune::PDELab::DirichletConstraintsParameters::isDirichlet ( const I &  intersection, const FieldVector< typename I::ctype, I::mydimension > &  coord  ) const

inline

Indicates whether the given position should be Dirichlet-constrained.

Parameters

intersection	The grid intersection containing the queried location.
coord	The position of the queried location in local coordinates of the intersection.

Returns

true iff the given location should have a Dirichlet constraint.

Referenced by Dune::PDELab::FluxFromDirichletConstraintsAdapter< DirichletConstraintsParameters >::isDirichlet(), and Dune::PDELab::FluxFromDirichletConstraintsAdapter< DirichletConstraintsParameters >::isNeumann().

isNeumann()

template<typename I >

bool Dune::PDELab::DirichletConstraintsParameters::isNeumann ( const I &  intersection, const FieldVector< typename I::ctype, I::mydimension > &  coord  ) const

inline

Indicates whether the given position should be Neumann-constrained.

Most of the time, this method will be equivalent to !isDirichlet(...), but sometimes (in particular in multi-domain scenarios), both methods may return false.

Parameters

intersection	The grid intersection containing the queried location.
coord	The position of the queried location in local coordinates of the intersection.

Returns

true iff the given location should have a Neumann constraint.

setTime()

template<typename T >

void Dune::PDELab::DirichletConstraintsParameters::setTime ( const T &  time )

inline

Sets the current time (only required for instationary problems).

Note

This method only needs to be implement for instationary problems.

Referenced by Dune::PDELab::FluxFromDirichletConstraintsAdapter< DirichletConstraintsParameters >::setTime().

---

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

• dune/pdelab/constraints/common/constraintsparameters.hh