dune-fem  2.4.1-rc
Public Types | Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
Dune::Fem::VectorDiscreteFunction< DiscreteFunctionSpace, Vector > Class Template Reference

#include </local/tomalk/somewhere/tmp/dune-fem/dune/fem/function/vectorfunction/vectorfunction.hh>

Inheritance diagram for Dune::Fem::VectorDiscreteFunction< DiscreteFunctionSpace, Vector >:
Inheritance graph

Public Types

typedef Vector VectorType
 
typedef BaseType::DiscreteFunctionSpaceType DiscreteFunctionSpaceType
 
typedef BaseType::DofVectorType DofVectorType
 
typedef DofVectorType::DofContainerType DofContainerType
 
typedef BaseType::DofType DofType
 
enum  
 size of the dof blocks More...
 
typedef BaseType::Traits Traits
 
typedef VectorDiscreteFunction< DiscreteFunctionSpace, Vector > DiscreteFunctionType
 type of the discrete function (Barton-Nackman parameter) More...
 
typedef BaseType::DiscreteFunctionInterfaceType DiscreteFunctionInterfaceType
 
typedef BaseType::GridPartType GridPartType
 type of the underlying grid part More...
 
typedef DiscreteFunctionSpaceType::DomainType DomainType
 type of domain vector More...
 
typedef DiscreteFunctionSpaceType::RangeType RangeType
 type of range vector More...
 
typedef DiscreteFunctionSpaceType::JacobianRangeType JacobianRangeType
 type of jacobian More...
 
typedef DiscreteFunctionSpaceType::HessianRangeType HessianRangeType
 type of hessian More...
 
typedef DiscreteFunctionSpaceType::DomainFieldType DomainFieldType
 type of domain field (usually a float type) More...
 
typedef DiscreteFunctionSpaceType::RangeFieldType RangeFieldType
 type of range field (usually a float type) More...
 
typedef Traits::DofIteratorType DofIteratorType
 type of the dof iterator More...
 
typedef Traits::ConstDofIteratorType ConstDofIteratorType
 type of the const dof iterator More...
 
typedef Traits::LocalDofVectorType LocalDofVectorType
 type of LocalDofVector More...
 
typedef Traits::LocalDofVectorAllocatorType LocalDofVectorAllocatorType
 type of LocalDofVector More...
 
typedef BaseType::LocalFunctionType LocalFunctionType
 type of local functions More...
 
typedef BaseType::DofBlockType DofBlockType
 
typedef BaseType::ConstDofBlockType ConstDofBlockType
 
typedef BaseType::DofBlockPtrType DofBlockPtrType
 
typedef BaseType::ConstDofBlockPtrType ConstDofBlockPtrType
 
typedef BaseType::EntityType EntityType
 
typedef DofVectorType::SizeType SizeType
 size type of the block vector More...
 
enum  
 size of the dof blocks More...
 
typedef DiscreteFunctionSpaceType::GridType GridType
 Type of the underlying grid. More...
 
typedef BaseType::MappingType MappingType
 type of mapping base class for this discrete function More...
 
typedef LoadBalanceLeafData< ThisTypeDefaultLoadBalanceContainsCheckType
 
typedef DiscreteFunctionTraits< VectorDiscreteFunction< DiscreteFunctionSpace, Vector > >::DiscreteFunctionSpaceType::FunctionSpaceType FunctionSpaceType
 type of function space this function belongs to More...
 
typedef VectorDiscreteFunction< DiscreteFunctionSpace, Vector > FunctionType
 type of the implementation (Barton-Nackman) More...
 

Public Member Functions

 VectorDiscreteFunction (const std::string &name, const DiscreteFunctionSpaceType &space, VectorType &vector)
 
 VectorDiscreteFunction (const VectorDiscreteFunction &other)
 
DofVectorTypedofVector ()
 
const DofVectorTypedofVector () const
 
const std::string & name () const
 obtain the name of the discrete function More...
 
const DiscreteFunctionSpaceTypespace () const
 obtain a reference to the corresponding DiscreteFunctionSpace More...
 
const GridPartTypegridPart () const
 obtain a reference to the underlying grid part More...
 
LocalFunctionType localFunction (const EntityType &entity)
 obtain a local function for an entity (read-write) More...
 
const LocalFunctionType localFunction (const EntityType &entity) const
 obtain a local function for an entity (read-write) More...
 
void clear ()
 set all degrees of freedom to zero More...
 
int blocks () const
 obtain total number of blocks, i.e. size / blockSize. More...
 
DofBlockPtrType block (unsigned int index)
 obtain pointer to block of discrete function with block number index (read-only) More...
 
ConstDofBlockPtrType block (unsigned int index) const
 obtain pointer to block of discrete function with block number index More...
 
SizeType size () const
 Return the number of blocks in the block vector. More...
 
ConstDofIteratorType dbegin () const
 Obtain the constant iterator pointing to the first dof. More...
 
DofIteratorType dbegin ()
 Obtain the non-constant iterator pointing to the first dof. More...
 
ConstDofIteratorType dend () const
 Obtain the constant iterator pointing to the last dof. More...
 
DofIteratorType dend ()
 Obtain the non-constant iterator pointing to the last dof. More...
 
RangeFieldTypeallocDofPointer () const
 allocate a pointer to a consecutive array storing the DoFs More...
 
void freeDofPointer (RangeFieldType *dofPointer)
 allocate a pointer to a consecutive array storing the DoFs More...
 
void freeDofPointerNoCopy (const RangeFieldType *dofPointer) const
 allocate a pointer to a consecutive array storing the DoFs More...
 
void axpy (const RangeFieldType &s, const DiscreteFunctionInterface< DFType > &g)
 axpy operation More...
 
void axpy (const RangeFieldType &s, const DiscreteFunctionInterfaceType &g)
 axpy operation More...
 
RangeFieldType scalarProductDofs (const DiscreteFunctionInterface< DFType > &other) const
 Scalar product between the DoFs of two discrete functions. More...
 
Dune::FieldTraits< RangeFieldType >::real_type normSquaredDofs () const
 Squared small l^2 norm of all dofs. More...
 
void print (std::ostream &out) const
 print all DoFs to a stream (for debugging purposes) More...
 
bool dofsValid () const
 check for NaNs More...
 
void assign (const DiscreteFunctionInterface< DFType > &g)
 
void assign (const DiscreteFunctionType &g)
 
CommDataHandle< Operation >::Type dataHandle (const Operation *operation)
 return reference to data handle object More...
 
void communicate ()
 do default communication of space for this discrete function More...
 
void evaluate (const DomainType &x, RangeType &value) const
 evaluate the function More...
 
void evaluate (const DomainType &x, RangeType &value) const
 evaluate the function More...
 
void jacobian (const DomainType &x, JacobianRangeType &jacobian) const
 evaluate the Jacobian of the function More...
 
void jacobian (const DomainType &x, JacobianRangeType &jacobian) const
 evaluate the Jacobian of the function More...
 
void hessian (const DomainType &x, HessianRangeType &hessian) const
 evaluate the hessian of the function (const DomainType &x,HessianRangeType &hessian) const More...
 
void hessian (const DomainType &x, HessianRangeType &hessian) const
 evaluate the hessian of the function More...
 
DiscreteFunctionTypeoperator+= (const DiscreteFunctionInterface< DFType > &g)
 add another discrete function to this one More...
 
DiscreteFunctionTypeoperator+= (const DiscreteFunctionType &g)
 add another discrete function to this one More...
 
DiscreteFunctionTypeoperator-= (const DiscreteFunctionInterface< DFType > &g)
 substract all degrees of freedom from given discrete function using the dof iterators More...
 
DiscreteFunctionTypeoperator-= (const DiscreteFunctionType &g)
 substract all degrees of freedom from given discrete function using the dof iterators More...
 
DiscreteFunctionTypeoperator*= (const RangeFieldType &scalar)
 multiply all DoFs with a scalar factor More...
 
DiscreteFunctionTypeoperator/= (const RangeFieldType &scalar)
 devide all DoFs by a scalar factor More...
 
void read (InStreamInterface< StreamTraits > &in)
 read the discrete function from a stream More...
 
void write (OutStreamInterface< StreamTraits > &out) const
 write the discrete function into a stream More...
 
void enableDofCompression ()
 Enable this discrete function for dof compression, i.e. during grdi changes a dof compression is done when the DofManagers compress is called. More...
 
bool operator== (const DiscreteFunctionInterface< DFType > &g) const
 
bool operator!= (const DiscreteFunctionInterface< DFType > &g) const
 
LocalDofVectorAllocatorTypelocalDofVectorAllocator () const
 obtain the local function storage More...
 
void addScaledLocalDofs (const EntityType &entity, const RangeFieldType &s, const LocalDofs &localDofs)
 add scaled local Dofs to dof vector More...
 
void addLocalDofs (const EntityType &entity, const LocalDofs &localDofs)
 add local Dofs to dof vector More...
 
void setLocalDofs (const EntityType &entity, const LocalDofs &localDofs)
 set local Dofs to dof vector More...
 
void getLocalDofs (const EntityType &entity, LocalDofVectorType &localDofs)
 get local Dofs and store a reference to it in the LocalDofVector More...
 
void getLocalDofs (const EntityType &entity, Dune::DynamicVector< DofType, A > &localDofs) const
 get local Dofs and store the values in LocalDofVector More...
 
DefaultLoadBalanceContainsCheckType defaultLoadBalanceContainsCheck () const
 
virtual void operator() (const DomainType &arg, RangeType &dest) const
 application operator call evaluate More...
 
void operator() (const DomainType &arg, RangeType &dest) const
 Application operator that applies all operators in the linear combination stack. More...
 

Protected Member Functions

VectorTypeallocateDofVector (const DiscreteFunctionSpaceType &space)
 
virtual void backup () const
 
virtual void restore ()
 
virtual void insertSubData ()
 
virtual void removeSubData ()
 
void evaluateGlobal (const DomainType &x, Functor functor) const
 evaluate functor in global coordinate More...
 
const VectorDiscreteFunction< DiscreteFunctionSpace, Vector > & asImp () const
 
VectorDiscreteFunction< DiscreteFunctionSpace, Vector > & asImp ()
 
virtual void * pointer ()
 

Static Protected Member Functions

static const VectorDiscreteFunction< DiscreteFunctionSpace, Vector > & asImp (const ThisType &other)
 
static VectorDiscreteFunction< DiscreteFunctionSpace, Vector > & asImp (ThisType &other)
 

Protected Attributes

std::unique_ptr< VectorTypevec_
 
DofVectorType dofVector_
 
const DiscreteFunctionSpaceTypedfSpace_
 
Traits::LocalDofVectorStackType ldvStack_
 
LocalDofVectorAllocatorType ldvAllocator_
 
DebugLock dofPointerLock_
 
std::string name_
 
ScalarProductType scalarProduct_
 

Member Typedef Documentation

type of the const dof iterator

template<class DiscreteFunctionSpace , class Vector >
typedef BaseType :: DiscreteFunctionSpaceType Dune::Fem::VectorDiscreteFunction< DiscreteFunctionSpace, Vector >::DiscreteFunctionSpaceType

type of the discrete function (Barton-Nackman parameter)

template<class DiscreteFunctionSpace , class Vector >
typedef DofVectorType :: DofContainerType Dune::Fem::VectorDiscreteFunction< DiscreteFunctionSpace, Vector >::DofContainerType

type of the dof iterator

template<class DiscreteFunctionSpace , class Vector >
typedef BaseType :: DofType Dune::Fem::VectorDiscreteFunction< DiscreteFunctionSpace, Vector >::DofType
template<class DiscreteFunctionSpace , class Vector >
typedef BaseType :: DofVectorType Dune::Fem::VectorDiscreteFunction< DiscreteFunctionSpace, Vector >::DofVectorType

type of domain field (usually a float type)

type of domain vector

typedef DiscreteFunctionTraits< VectorDiscreteFunction< DiscreteFunctionSpace, Vector > >::DiscreteFunctionSpaceType::FunctionSpaceType Dune::Fem::Function< DiscreteFunctionTraits< VectorDiscreteFunction< DiscreteFunctionSpace, Vector > >::DiscreteFunctionSpaceType::FunctionSpaceType , VectorDiscreteFunction< DiscreteFunctionSpace, Vector > >::FunctionSpaceType
inherited

type of function space this function belongs to

type of the implementation (Barton-Nackman)

type of the underlying grid part

Type of the underlying grid.

type of hessian

type of jacobian

type of LocalDofVector

type of LocalDofVector

type of local functions

type of mapping base class for this discrete function

type of range field (usually a float type)

type of range vector

typedef DofVectorType::SizeType Dune::Fem::DiscreteFunctionDefault< VectorDiscreteFunction< DiscreteFunctionSpace, Vector > >::SizeType
inherited

size type of the block vector

template<class DiscreteFunctionSpace , class Vector >
typedef Vector Dune::Fem::VectorDiscreteFunction< DiscreteFunctionSpace, Vector >::VectorType

Member Enumeration Documentation

anonymous enum
inherited

size of the dof blocks

anonymous enum
inherited

size of the dof blocks

Constructor & Destructor Documentation

template<class DiscreteFunctionSpace , class Vector >
Dune::Fem::VectorDiscreteFunction< DiscreteFunctionSpace, Vector >::VectorDiscreteFunction ( const std::string &  name,
const DiscreteFunctionSpaceType space,
VectorType vector 
)
inline
template<class DiscreteFunctionSpace , class Vector >
Dune::Fem::VectorDiscreteFunction< DiscreteFunctionSpace, Vector >::VectorDiscreteFunction ( const VectorDiscreteFunction< DiscreteFunctionSpace, Vector > &  other)
inline

Member Function Documentation

void Dune::Fem::DiscreteFunctionDefault< VectorDiscreteFunction< DiscreteFunctionSpace, Vector > >::addLocalDofs ( const EntityType entity,
const LocalDofs &  localDofs 
)
inlineinherited

add local Dofs to dof vector

void Dune::Fem::DiscreteFunctionDefault< VectorDiscreteFunction< DiscreteFunctionSpace, Vector > >::addScaledLocalDofs ( const EntityType entity,
const RangeFieldType s,
const LocalDofs &  localDofs 
)
inlineinherited

add scaled local Dofs to dof vector

template<class DiscreteFunctionSpace , class Vector >
VectorType& Dune::Fem::VectorDiscreteFunction< DiscreteFunctionSpace, Vector >::allocateDofVector ( const DiscreteFunctionSpaceType space)
inlineprotected
RangeFieldType* Dune::Fem::DiscreteFunctionDefault< VectorDiscreteFunction< DiscreteFunctionSpace, Vector > >::allocDofPointer ( ) const
inlineinherited

allocate a pointer to a consecutive array storing the DoFs

To support external packages, it is often required to have the DoFs in a consecutive array. This function ensures this, making a copy if necessary.

Note
The allocated pointer has to be freed by freeDofPointer.
Only one DoF pointer may be allocated at a time.
Returns
a pointer to a consecutive copy of the DoF vector
Note
The default implementation make a copy of the DoF vector using the DoF iterators.
static const VectorDiscreteFunction< DiscreteFunctionSpace, Vector > & Dune::Fem::BartonNackmanInterface< Function< DiscreteFunctionTraits< VectorDiscreteFunction< DiscreteFunctionSpace, Vector > >::DiscreteFunctionSpaceType::FunctionSpaceType, VectorDiscreteFunction< DiscreteFunctionSpace, Vector > > , VectorDiscreteFunction< DiscreteFunctionSpace, Vector > >::asImp ( const ThisType other)
inlinestaticprotectedinherited
static VectorDiscreteFunction< DiscreteFunctionSpace, Vector > & Dune::Fem::BartonNackmanInterface< Function< DiscreteFunctionTraits< VectorDiscreteFunction< DiscreteFunctionSpace, Vector > >::DiscreteFunctionSpaceType::FunctionSpaceType, VectorDiscreteFunction< DiscreteFunctionSpace, Vector > > , VectorDiscreteFunction< DiscreteFunctionSpace, Vector > >::asImp ( ThisType other)
inlinestaticprotectedinherited
const VectorDiscreteFunction< DiscreteFunctionSpace, Vector > & Dune::Fem::BartonNackmanInterface< Function< DiscreteFunctionTraits< VectorDiscreteFunction< DiscreteFunctionSpace, Vector > >::DiscreteFunctionSpaceType::FunctionSpaceType, VectorDiscreteFunction< DiscreteFunctionSpace, Vector > > , VectorDiscreteFunction< DiscreteFunctionSpace, Vector > >::asImp ( ) const
inlineprotectedinherited

void Dune::Fem::DiscreteFunctionDefault< VectorDiscreteFunction< DiscreteFunctionSpace, Vector > >::axpy ( const RangeFieldType s,
const DiscreteFunctionInterface< DFType > &  g 
)
inherited

axpy operation

Adds s * g to this discrete function.

Parameters
[in]sscalar value to scale g with
[in]gdiscrete function to add

axpy operation

Adds s * g to this discrete function.

Parameters
[in]sscalar value to scale g with
[in]gdiscrete function to add
virtual void Dune::Fem::DiscreteFunctionDefault< VectorDiscreteFunction< DiscreteFunctionSpace, Vector > >::backup ( ) const
inlineprotectedvirtualinherited
DofBlockPtrType Dune::Fem::DiscreteFunctionDefault< VectorDiscreteFunction< DiscreteFunctionSpace, Vector > >::block ( unsigned int  index)
inlineinherited

obtain pointer to block of discrete function with block number index (read-only)

Returns
a DoFBlockPtrType pointing to block index (read-only)
ConstDofBlockPtrType Dune::Fem::DiscreteFunctionDefault< VectorDiscreteFunction< DiscreteFunctionSpace, Vector > >::block ( unsigned int  index) const
inlineinherited

obtain pointer to block of discrete function with block number index

Returns
a DoFBlockPtrType pointing to block index
int Dune::Fem::DiscreteFunctionDefault< VectorDiscreteFunction< DiscreteFunctionSpace, Vector > >::blocks ( ) const
inlineinherited

obtain total number of blocks, i.e. size / blockSize.

The number of blocks of DoFs (degrees of freedom) can also be seen as the size of the discrete function divided by the blockSize.

Returns
total number of DoFs blocks

set all degrees of freedom to zero

void Dune::Fem::DiscreteFunctionDefault< VectorDiscreteFunction< DiscreteFunctionSpace, Vector > >::communicate ( )
inlineinherited

do default communication of space for this discrete function

CommDataHandle< Operation >:: Type Dune::Fem::DiscreteFunctionDefault< VectorDiscreteFunction< DiscreteFunctionSpace, Vector > >::dataHandle ( const Operation *  operation)
inherited

return reference to data handle object

Obtain the constant iterator pointing to the first dof.

Returns
Constant iterator pointing to the first dof

Obtain the non-constant iterator pointing to the first dof.

Returns
Non-Constant iterator pointing to the first dof
DefaultLoadBalanceContainsCheckType Dune::Fem::DiscreteFunctionInterface< VectorDiscreteFunction< DiscreteFunctionSpace, Vector > >::defaultLoadBalanceContainsCheck ( ) const
inlineinherited

Obtain the constant iterator pointing to the last dof.

Returns
Constant iterator pointing to the last dof

Obtain the non-constant iterator pointing to the last dof.

Returns
Non-Constant iterator pointing to the last dof
bool Dune::Fem::DiscreteFunctionDefault< VectorDiscreteFunction< DiscreteFunctionSpace, Vector > >::dofsValid ( ) const
inlineinherited

check for NaNs

Returns
if one of the DoFs is NaN false is returned, otherwise true
template<class DiscreteFunctionSpace , class Vector >
DofVectorType& Dune::Fem::VectorDiscreteFunction< DiscreteFunctionSpace, Vector >::dofVector ( )
inline
template<class DiscreteFunctionSpace , class Vector >
const DofVectorType& Dune::Fem::VectorDiscreteFunction< DiscreteFunctionSpace, Vector >::dofVector ( ) const
inline
void Dune::Fem::DiscreteFunctionDefault< VectorDiscreteFunction< DiscreteFunctionSpace, Vector > >::enableDofCompression ( )
inlineinherited

Enable this discrete function for dof compression, i.e. during grdi changes a dof compression is done when the DofManagers compress is called.

Note
The default implementation does nothing.
void Dune::Fem::Function< DiscreteFunctionTraits< VectorDiscreteFunction< DiscreteFunctionSpace, Vector > >::DiscreteFunctionSpaceType::FunctionSpaceType , VectorDiscreteFunction< DiscreteFunctionSpace, Vector > >::evaluate ( const DomainType x,
RangeType value 
) const
inlineinherited

evaluate the function

Parameters
[in]xevaluation point
[out]valuevalue of the function in x
void Dune::Fem::DiscreteFunctionDefault< VectorDiscreteFunction< DiscreteFunctionSpace, Vector > >::evaluate ( const DomainType x,
RangeType value 
) const
inlineinherited

evaluate the function

Parameters
[in]xevaluation point
[out]valuevalue of the function in x
void Dune::Fem::DiscreteFunctionDefault< VectorDiscreteFunction< DiscreteFunctionSpace, Vector > >::evaluateGlobal ( const DomainType x,
Functor  functor 
) const
protectedinherited

evaluate functor in global coordinate

void Dune::Fem::DiscreteFunctionDefault< VectorDiscreteFunction< DiscreteFunctionSpace, Vector > >::freeDofPointer ( RangeFieldType dofPointer)
inlineinherited

allocate a pointer to a consecutive array storing the DoFs

This method serves two purposes:

  • The user cannot know, if the DoF array returned by allocDofPointer has to be freed.
  • If the DoF array is just a copy, the DoFs shall be stored back into the discrete function.
Note
The pointer must have been allocated by allocDofPointer.
Only one DoF pointer may be allocated at a time.
Parameters
[in]dofPointerpointer to the dof array previously allocated by allocDofPointer
Note
The default implementation make a copy of the DoF vector using the DoF iterators.
void Dune::Fem::DiscreteFunctionDefault< VectorDiscreteFunction< DiscreteFunctionSpace, Vector > >::freeDofPointerNoCopy ( const RangeFieldType dofPointer) const
inlineinherited

allocate a pointer to a consecutive array storing the DoFs

This method serves sincet the user cannot know, if the DoF array returned by allocDofPointer has to be freed.

Note
The pointer must have been allocated by allocDofPointer.
Only one DoF pointer may be allocated at a time.
DoFs are NOT stored back into the discrete function.
Parameters
[in]dofPointerpointer to the dof array previously allocated by allocDofPointer
Note
The default implementation make a copy of the DoF vector using the DoF iterators.
void Dune::Fem::DiscreteFunctionDefault< VectorDiscreteFunction< DiscreteFunctionSpace, Vector > >::getLocalDofs ( const EntityType entity,
LocalDofVectorType localDofs 
)
inlineinherited

get local Dofs and store a reference to it in the LocalDofVector

void Dune::Fem::DiscreteFunctionDefault< VectorDiscreteFunction< DiscreteFunctionSpace, Vector > >::getLocalDofs ( const EntityType entity,
Dune::DynamicVector< DofType, A > &  localDofs 
) const
inlineinherited

get local Dofs and store the values in LocalDofVector

const GridPartType& Dune::Fem::DiscreteFunctionDefault< VectorDiscreteFunction< DiscreteFunctionSpace, Vector > >::gridPart ( ) const
inlineinherited

obtain a reference to the underlying grid part

void Dune::Fem::Function< DiscreteFunctionTraits< VectorDiscreteFunction< DiscreteFunctionSpace, Vector > >::DiscreteFunctionSpaceType::FunctionSpaceType , VectorDiscreteFunction< DiscreteFunctionSpace, Vector > >::hessian ( const DomainType x,
HessianRangeType hessian 
) const
inlineinherited

evaluate the hessian of the function

Parameters
[in]xevaluation point
[out]hessianvalue of the hessian in x
void Dune::Fem::DiscreteFunctionDefault< VectorDiscreteFunction< DiscreteFunctionSpace, Vector > >::hessian ( const DomainType x,
HessianRangeType hessian 
) const
inlineinherited

evaluate the hessian of the function (const DomainType &x,HessianRangeType &hessian) const

Parameters
[in]xevaluation point
[out]hessianvalue of the hessian in x (const DomainType &x,HessianRangeType &hessian) const
virtual void Dune::Fem::DiscreteFunctionDefault< VectorDiscreteFunction< DiscreteFunctionSpace, Vector > >::insertSubData ( )
protectedvirtualinherited

Reimplemented from Dune::Fem::PersistentObject.

void Dune::Fem::Function< DiscreteFunctionTraits< VectorDiscreteFunction< DiscreteFunctionSpace, Vector > >::DiscreteFunctionSpaceType::FunctionSpaceType , VectorDiscreteFunction< DiscreteFunctionSpace, Vector > >::jacobian ( const DomainType x,
JacobianRangeType jacobian 
) const
inlineinherited

evaluate the Jacobian of the function

Parameters
[in]xevaluation point
[out]jacobianvalue of the Jacobian in x
void Dune::Fem::DiscreteFunctionDefault< VectorDiscreteFunction< DiscreteFunctionSpace, Vector > >::jacobian ( const DomainType x,
JacobianRangeType jacobian 
) const
inlineinherited

evaluate the Jacobian of the function

Parameters
[in]xevaluation point
[out]jacobianvalue of the Jacobian in x
LocalDofVectorAllocatorType& Dune::Fem::DiscreteFunctionDefault< VectorDiscreteFunction< DiscreteFunctionSpace, Vector > >::localDofVectorAllocator ( ) const
inlineinherited

obtain the local function storage

Returns
a reference to the local function storage
LocalFunctionType Dune::Fem::DiscreteFunctionDefault< VectorDiscreteFunction< DiscreteFunctionSpace, Vector > >::localFunction ( const EntityType entity)
inlineinherited

obtain a local function for an entity (read-write)

Parameters
[in]entityEntity to focus view of discrete function
Returns
a local function associated with the entity
const LocalFunctionType Dune::Fem::DiscreteFunctionDefault< VectorDiscreteFunction< DiscreteFunctionSpace, Vector > >::localFunction ( const EntityType entity) const
inlineinherited

obtain a local function for an entity (read-write)

Parameters
[in]entityEntity to focus view of discrete function
Returns
a local function associated with the entity
const std::string& Dune::Fem::DiscreteFunctionDefault< VectorDiscreteFunction< DiscreteFunctionSpace, Vector > >::name ( ) const
inlineinherited

obtain the name of the discrete function

Returns
string holding name of discrete function
Dune::FieldTraits< RangeFieldType >::real_type Dune::Fem::DiscreteFunctionDefault< VectorDiscreteFunction< DiscreteFunctionSpace, Vector > >::normSquaredDofs ( ) const
inlineinherited

Squared small l^2 norm of all dofs.

Note
This is already parallel, so do not sum over all processes after calling scalarProductDofs!
It is assumed that the discrete function has been communicated (i.e., every local DoF hat the value of the corresponding global DoF).
Returns
the squared norm of the DoF-vectors
bool Dune::Fem::DiscreteFunctionDefault< VectorDiscreteFunction< DiscreteFunctionSpace, Vector > >::operator!= ( const DiscreteFunctionInterface< DFType > &  g) const
inlineinherited
virtual void Dune::Fem::Function< DiscreteFunctionTraits< VectorDiscreteFunction< DiscreteFunctionSpace, Vector > >::DiscreteFunctionSpaceType::FunctionSpaceType , VectorDiscreteFunction< DiscreteFunctionSpace, Vector > >::operator() ( const DomainType arg,
RangeType dest 
) const
inlinevirtualinherited

application operator call evaluate

Parameters
[in]argargument
[out]destdestination, i.e. f(arg)
void Dune::Fem::Mapping< DiscreteFunctionTraits< VectorDiscreteFunction< DiscreteFunctionSpace, Vector > >::DiscreteFunctionSpaceType::FunctionSpaceType::DomainFieldType , DiscreteFunctionTraits< VectorDiscreteFunction< DiscreteFunctionSpace, Vector > >::DiscreteFunctionSpaceType::FunctionSpaceType::RangeFieldType , DiscreteFunctionTraits< VectorDiscreteFunction< DiscreteFunctionSpace, Vector > >::DiscreteFunctionSpaceType::FunctionSpaceType::DomainType , DiscreteFunctionTraits< VectorDiscreteFunction< DiscreteFunctionSpace, Vector > >::DiscreteFunctionSpaceType::FunctionSpaceType::RangeType >::operator() ( const DomainType arg,
RangeType dest 
) const
inlineinherited

Application operator that applies all operators in the linear combination stack.

Parameters
[in]argargument
[out]destdestination

multiply all DoFs with a scalar factor

Parameters
[in]scalarfactor to multiply DoFs with
Returns
reference to this discrete function (i.e. *this)

add another discrete function to this one

Parameters
[in]gdiscrete function to add
Returns
a reference to this discrete function (i.e. *this)

add another discrete function to this one

Parameters
[in]gdiscrete function to add
Returns
a reference to this discrete function (i.e. *this)

substract all degrees of freedom from given discrete function using the dof iterators

Parameters
[in]gdiscrete function which is substracted from this discrete function
Returns
reference to this (i.e. *this)

substract all degrees of freedom from given discrete function using the dof iterators

Parameters
[in]gdiscrete function which is substracted from this discrete function
Returns
reference to this (i.e. *this)

devide all DoFs by a scalar factor

Parameters
[in]scalarfactor with which all dofs are devided
Returns
reference to this discrete function (i.e. *this)
bool Dune::Fem::DiscreteFunctionDefault< VectorDiscreteFunction< DiscreteFunctionSpace, Vector > >::operator== ( const DiscreteFunctionInterface< DFType > &  g) const
inlineinherited
virtual void* Dune::Fem::PersistentObject::pointer ( )
inlineprotectedvirtualinherited
void Dune::Fem::DiscreteFunctionDefault< VectorDiscreteFunction< DiscreteFunctionSpace, Vector > >::print ( std::ostream &  out) const
inherited

print all DoFs to a stream (for debugging purposes)

Parameters
[in]outstream to print to
void Dune::Fem::DiscreteFunctionDefault< VectorDiscreteFunction< DiscreteFunctionSpace, Vector > >::read ( InStreamInterface< StreamTraits > &  in)
inlineinherited

read the discrete function from a stream

Parameters
[in]instream to read the discrete function from
virtual void Dune::Fem::DiscreteFunctionDefault< VectorDiscreteFunction< DiscreteFunctionSpace, Vector > >::removeSubData ( )
protectedvirtualinherited

Reimplemented from Dune::Fem::PersistentObject.

virtual void Dune::Fem::DiscreteFunctionDefault< VectorDiscreteFunction< DiscreteFunctionSpace, Vector > >::restore ( )
inlineprotectedvirtualinherited
RangeFieldType Dune::Fem::DiscreteFunctionDefault< VectorDiscreteFunction< DiscreteFunctionSpace, Vector > >::scalarProductDofs ( const DiscreteFunctionInterface< DFType > &  other) const
inlineinherited

Scalar product between the DoFs of two discrete functions.

Note
This is a parallel scalar product, so do not sum over all processes after calling scalarProductDofs!
It is assumed that the discrete function has been communicated (i.e., every local DoF hat the value of the corresponding global DoF).
Parameters
[in]otherdiscrete function to evaluate the scalar product with
Returns
the scalar product of the DoF-vectors
void Dune::Fem::DiscreteFunctionDefault< VectorDiscreteFunction< DiscreteFunctionSpace, Vector > >::setLocalDofs ( const EntityType entity,
const LocalDofs &  localDofs 
)
inlineinherited

set local Dofs to dof vector

Return the number of blocks in the block vector.

Returns
Number of block in the block vector

obtain a reference to the corresponding DiscreteFunctionSpace

void Dune::Fem::DiscreteFunctionDefault< VectorDiscreteFunction< DiscreteFunctionSpace, Vector > >::write ( OutStreamInterface< StreamTraits > &  out) const
inlineinherited

write the discrete function into a stream

Parameters
[in]outstream to write the discrete function to

Member Data Documentation

DebugLock Dune::Fem::DiscreteFunctionDefault< VectorDiscreteFunction< DiscreteFunctionSpace, Vector > >::dofPointerLock_
mutableprotectedinherited
template<class DiscreteFunctionSpace , class Vector >
DofVectorType Dune::Fem::VectorDiscreteFunction< DiscreteFunctionSpace, Vector >::dofVector_
protected
Traits :: LocalDofVectorStackType Dune::Fem::DiscreteFunctionDefault< VectorDiscreteFunction< DiscreteFunctionSpace, Vector > >::ldvStack_
protectedinherited
std::string Dune::Fem::DiscreteFunctionDefault< VectorDiscreteFunction< DiscreteFunctionSpace, Vector > >::name_
protectedinherited
template<class DiscreteFunctionSpace , class Vector >
std::unique_ptr< VectorType > Dune::Fem::VectorDiscreteFunction< DiscreteFunctionSpace, Vector >::vec_
protected

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