forward declaration More...

Classes
struct	SubDiscreteFunction
	helper struct to get the type of the i-th sub function More...

Public Types
typedef TupleDiscreteFunctionSpace< typename DiscreteFunctions::DiscreteFunctionSpaceType ... >	DiscreteFunctionSpaceType
	type for the discrete function space this function lives in

typedef TupleDiscreteFunction< DiscreteFunctions ... >	DiscreteFunctionType
	type of the discrete function (Barton-Nackman parameter)

typedef BaseType::GridPartType	GridPartType
	type of the underlying grid part

typedef DiscreteFunctionSpaceType ::DomainType	DomainType
	type of domain vector

typedef DiscreteFunctionSpaceType ::RangeType	RangeType
	type of range vector

typedef DiscreteFunctionSpaceType ::JacobianRangeType	JacobianRangeType
	type of jacobian

typedef DiscreteFunctionSpaceType ::HessianRangeType	HessianRangeType
	type of hessian

typedef DiscreteFunctionSpaceType ::DomainFieldType	DomainFieldType
	type of domain field (usually a float type)

typedef DiscreteFunctionSpaceType ::RangeFieldType	RangeFieldType
	type of range field (usually a float type)

typedef Traits ::DofIteratorType	DofIteratorType
	type of the dof iterator

typedef Traits ::ConstDofIteratorType	ConstDofIteratorType
	type of the const dof iterator

typedef Traits ::LocalDofVectorType	LocalDofVectorType
	type of LocalDofVector

typedef Traits ::LocalDofVectorAllocatorType	LocalDofVectorAllocatorType
	type of LocalDofVector

typedef BaseType ::LocalFunctionType	LocalFunctionType
	type of local functions

typedef DofVectorType::SizeType	SizeType
	size type of the block vector

typedef DiscreteFunctionSpaceType ::FunctionSpaceType	FunctionSpaceType
	type of associated function space

typedef DiscreteFunctionSpaceType ::GridType	GridType
	type of the underlying grid

typedef BaseType ::MappingType	MappingType
	type of mapping base class for this discrete function

typedef TupleDiscreteFunction< DiscreteFunctions ... >	FunctionType
	type of the implementation (Barton-Nackman)

Public Member Functions
	TupleDiscreteFunction (const std::string &name, const DiscreteFunctionSpaceType &dfSpace, DofVectorType &dofVector)
	Constructor to use if the vector storing the dofs (which is a block vector) already exists. More...

	TupleDiscreteFunction (const std::string &name, const DiscreteFunctionSpaceType &dfSpace)
	Constructor to use if the vector storing the dofs does not exist yet. More...

void	enableDofCompression ()
	Enable this discrete function for dof compression, i.e. during grid changes a dof compression is done when the DofManagers compress is called. More...

const DiscreteFunctionSpaceType &	space () const
	obtain a reference to the corresponding DiscreteFunctionSpace More...

const std::string &	name () const
	obtain the name of the discrete function More...

std::string &	name ()
	obtain the name of the discrete function More...

constexpr int	order () const
	obtain an upper bound on the polynomial order of the underlying space. More...

bool	continuous () const
	returns true if the space contains only globally continuous functions More...

const DiscreteFunctionSpaceType &	space () const
	obtain a reference to the corresponding DiscreteFunctionSpace More...

const GridPartType &	gridPart () const
	obtain a reference to the underlying grid part

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

LocalFunctionType	localFunction ()
	obtain an uninitialized local function (read-write) More...

const LocalFunctionType	localFunction () const
	obtain an uninitialized local function (read-write) 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)

ConstDofBlockPtrType	block (unsigned int index) const

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

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

DiscreteFunctionType &	operator+= (const DiscreteFunctionInterface< DFType > &g)
	add another discrete function to this one More...

DiscreteFunctionType &	operator+= (const DiscreteFunctionType &g)
	add another discrete function to this one More...

DiscreteFunctionType &	operator-= (const DiscreteFunctionInterface< DFType > &g)
	substract all degrees of freedom from given discrete function using the dof iterators More...

DiscreteFunctionType &	operator-= (const DiscreteFunctionType &g)
	substract all degrees of freedom from given discrete function using the dof iterators More...

DiscreteFunctionType &	operator*= (const RangeFieldType &scalar)
	multiply all DoFs with a scalar factor More...

DiscreteFunctionType &	operator/= (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	addScaledLocalDofs (const EntityType &entity, const RangeFieldType &s, const LocalDofs &localDofs)
	add scaled local Dofs to dof vector associated with the entity More...

void	addScaledLocalDofs (const EntityType &entity, const RangeFieldType &s, const LocalDofs &localDofs)
	add scaled local Dofs to dof vector associated with the entity More...

void	addLocalDofs (const EntityType &entity, const LocalDofs &localDofs)
	add local Dofs to dof vector associated with the entity More...

void	addLocalDofs (const EntityType &entity, const LocalDofs &localDofs)
	add local Dofs to dof vector associated with the entity More...

void	setLocalDofs (const EntityType &entity, const LocalDofs &localDofs)
	set local Dofs to dof vector associated with the entity More...

void	setLocalDofs (const EntityType &entity, const LocalDofs &localDofs)
	set local Dofs to dof vector associated with the entity More...

void	getLocalDofs (const EntityType &entity, Vector &localDofs) const
	fill local Dofs to dof vector associated with the entity More...

void	getLocalDofs (const EntityType &entity, Vector &localDofs) const
	fill local Dofs to dof vector associated with the entity More...

LocalDofVectorAllocatorType &	localDofVectorAllocator () const
	obtain the local function storage More...

void	beginAssemble ()
	Initiate the assemble of values using the LocalContribution concept. More...

void	endAssemble (const bool communicate=true)
	Finalize the assemble of values using the LocalContribution concept. More...

void	getLocalDofReferences (const EntityType &entity, LocalDofVectorType &localDofs)
	get local Dofs and store a reference to it in the LocalDofVector

virtual void	operator() (const DomainType &arg, RangeType &dest) const
	application operator call evaluate More...

Static Public Attributes
static constexpr std::size_t	blockSize
	size of the dof blocks

Protected Member Functions
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

Related Functions
(Note that these are not member functions.)
std::ostream &	operator<< (std::ostream &out, const DiscreteFunctionInterface< TupleDiscreteFunction< DiscreteFunctions ... > > &df)
	write a discrete function into an STL stream More...

template<class DFieldType , class RFieldType , class DType , class RType >
static Mapping< DFieldType, RFieldType, DType, RType >	operator+ (const Mapping< DFieldType, RFieldType, DType, RType > &a, const Mapping< DFieldType, RFieldType, DType, RType > &b)
	add two mappings More...

template<class DFieldType , class RFieldType , class DType , class RType >
static Mapping< DFieldType, RFieldType, DType, RType >	operator- (const Mapping< DFieldType, RFieldType, DType, RType > &a, const Mapping< DFieldType, RFieldType, DType, RType > &b)
	substract two mappings More...

template<class DFieldType , class RFieldType , class DType , class RType >
static Mapping< DFieldType, RFieldType, DType, RType >	operator* (const Mapping< DFieldType, RFieldType, DType, RType > &mapping, const RFieldType &factor)
	scale mapping with factor More...

template<class DFieldType , class RFieldType , class DType , class RType >
static Mapping< DFieldType, RFieldType, DType, RType >	operator* (const RFieldType &factor, const Mapping< DFieldType, RFieldType, DType, RType > &mapping)
	scale mapping with factor More...

template<class DFieldType , class RFieldType , class DType , class RType >
static Mapping< DFieldType, RFieldType, DType, RType >	operator/ (const Mapping< DFieldType, RFieldType, DType, RType > &mapping, const RFieldType &factor)
	operator / for mappings More...

template<class DFieldType , class RFieldType , class DType , class RType >
static Mapping< DFieldType, RFieldType, DType, RType >	operator/ (const RFieldType &factor, const Mapping< DFieldType, RFieldType, DType, RType > &mapping)
	operator / for mappings More...

Detailed Description

template<class ... DiscreteFunctions>
class Dune::Fem::TupleDiscreteFunction< DiscreteFunctions >

forward declaration

Constructor & Destructor Documentation

◆ TupleDiscreteFunction() [1/2]

template<class ... DiscreteFunctions>

Dune::Fem::TupleDiscreteFunction< DiscreteFunctions >::TupleDiscreteFunction	(	const std::string &	name,
		const DiscreteFunctionSpaceType &	dfSpace,
		DofVectorType &	dofVector
	)

inline

Constructor to use if the vector storing the dofs (which is a block vector) already exists.

Parameters

[in]	name	name of the discrete function
[in]	dfSpace	space the discrete function lives in
[in]	blockVector	reference to the blockVector

◆ TupleDiscreteFunction() [2/2]

template<class ... DiscreteFunctions>

Dune::Fem::TupleDiscreteFunction< DiscreteFunctions >::TupleDiscreteFunction	(	const std::string &	name,
		const DiscreteFunctionSpaceType &	dfSpace
	)

inline

Constructor to use if the vector storing the dofs does not exist yet.

Parameters

[in]	name	name of the discrete function
[in]	dfSpace	space the discrete function lives in

Member Function Documentation

◆ addLocalDofs() [1/2]

void Dune::Fem::DiscreteFunctionInterface< TupleDiscreteFunction< DiscreteFunctions ... > >::addLocalDofs	(	const EntityType &	entity,
		const LocalDofs &	localDofs
	)

inlineinherited

add local Dofs to dof vector associated with the entity

Parameters

[in]	entity	Entity to focus view of discrete function
[in]	localDofs	the local dofs vector to be added

◆ addLocalDofs() [2/2]

void Dune::Fem::DiscreteFunctionDefault< TupleDiscreteFunction< DiscreteFunctions ... > >::addLocalDofs	(	const EntityType &	entity,
		const LocalDofs &	localDofs
	)

inlineinherited

add local Dofs to dof vector associated with the entity

Parameters

[in]	entity	Entity to focus view of discrete function
[in]	localDofs	the local dofs vector to be added

◆ addScaledLocalDofs() [1/2]

void Dune::Fem::DiscreteFunctionInterface< TupleDiscreteFunction< DiscreteFunctions ... > >::addScaledLocalDofs	(	const EntityType &	entity,
		const RangeFieldType &	s,
		const LocalDofs &	localDofs
	)

inlineinherited

add scaled local Dofs to dof vector associated with the entity

Parameters

[in]	entity	Entity to focus view of discrete function
[in]	s	scaling factor
[in]	localDofs	the local dofs vector to be added

◆ addScaledLocalDofs() [2/2]

void Dune::Fem::DiscreteFunctionDefault< TupleDiscreteFunction< DiscreteFunctions ... > >::addScaledLocalDofs	(	const EntityType &	entity,
		const RangeFieldType &	s,
		const LocalDofs &	localDofs
	)

inlineinherited

add scaled local Dofs to dof vector associated with the entity

Parameters

[in]	entity	Entity to focus view of discrete function
[in]	s	scaling factor
[in]	localDofs	the local dofs vector to be added

◆ assign() [1/2]

void Dune::Fem::DiscreteFunctionDefault< TupleDiscreteFunction< DiscreteFunctions ... > >::assign ( const DiscreteFunctionInterface< DFType > & g )

inlineinherited

◆ assign() [2/2]

void Dune::Fem::DiscreteFunctionDefault< TupleDiscreteFunction< DiscreteFunctions ... > >::assign ( const DiscreteFunctionType & g )

inlineinherited

◆ axpy() [1/2]

void Dune::Fem::DiscreteFunctionDefault< TupleDiscreteFunction< DiscreteFunctions ... > >::axpy	(	const RangeFieldType &	s,
		const DiscreteFunctionInterface< DFType > &	g
	)

inlineinherited

axpy operation

Adds s * g to this discrete function.

Parameters

[in]	s	scalar value to scale g with
[in]	g	discrete function to add

◆ axpy() [2/2]

void Dune::Fem::DiscreteFunctionDefault< TupleDiscreteFunction< DiscreteFunctions ... > >::axpy	(	const RangeFieldType &	s,
		const DiscreteFunctionInterfaceType &	g
	)

inlineinherited

axpy operation

Adds s * g to this discrete function.

Parameters

[in]	s	scalar value to scale g with
[in]	g	discrete function to add

◆ backup()

virtual void Dune::Fem::DiscreteFunctionDefault< TupleDiscreteFunction< DiscreteFunctions ... > >::backup ( ) const

inlineprotectedvirtualinherited

Implements Dune::Fem::PersistentObject.

◆ beginAssemble()

void Dune::Fem::DiscreteFunctionDefault< TupleDiscreteFunction< DiscreteFunctions ... > >::beginAssemble ( )

inlineinherited

Initiate the assemble of values using the LocalContribution concept.

Template Parameters

AssembleOperation the specific operation (Add, Set, ...)

◆ block() [1/2]

DofBlockPtrType Dune::Fem::DiscreteFunctionDefault< TupleDiscreteFunction< DiscreteFunctions ... > >::block ( unsigned int index )

inlineinherited

◆ block() [2/2]

ConstDofBlockPtrType Dune::Fem::DiscreteFunctionDefault< TupleDiscreteFunction< DiscreteFunctions ... > >::block ( unsigned int index ) const

inlineinherited

◆ blocks()

int Dune::Fem::DiscreteFunctionDefault< TupleDiscreteFunction< DiscreteFunctions ... > >::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

◆ clear()

void Dune::Fem::DiscreteFunctionDefault< TupleDiscreteFunction< DiscreteFunctions ... > >::clear ( )

inlineinherited

set all degrees of freedom to zero

◆ communicate()

void Dune::Fem::DiscreteFunctionDefault< TupleDiscreteFunction< DiscreteFunctions ... > >::communicate ( )

inlineinherited

do default communication of space for this discrete function

◆ continuous()

bool Dune::Fem::DiscreteFunctionDefault< TupleDiscreteFunction< DiscreteFunctions ... > >::continuous ( ) const

inlineinherited

returns true if the space contains only globally continuous functions

For example, a Lagrange space returns true while a discontiuous Galerkin space returns false.

Returns: true if the space contians only globally continous functions, false otherwise

◆ dataHandle()

CommDataHandle< Operation >::Type Dune::Fem::DiscreteFunctionDefault< TupleDiscreteFunction< DiscreteFunctions ... > >::dataHandle ( const Operation & operation )

inherited

return reference to data handle object

◆ dbegin() [1/2]

DofIteratorType Dune::Fem::DiscreteFunctionDefault< TupleDiscreteFunction< DiscreteFunctions ... > >::dbegin ( )

inlineinherited

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

Returns: Non-Constant iterator pointing to the first dof

◆ dbegin() [2/2]

ConstDofIteratorType Dune::Fem::DiscreteFunctionDefault< TupleDiscreteFunction< DiscreteFunctions ... > >::dbegin ( ) const

inlineinherited

Obtain the constant iterator pointing to the first dof.

Returns: Constant iterator pointing to the first dof

◆ dend() [1/2]

DofIteratorType Dune::Fem::DiscreteFunctionDefault< TupleDiscreteFunction< DiscreteFunctions ... > >::dend ( )

inlineinherited

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

Returns: Non-Constant iterator pointing to the last dof

◆ dend() [2/2]

ConstDofIteratorType Dune::Fem::DiscreteFunctionDefault< TupleDiscreteFunction< DiscreteFunctions ... > >::dend ( ) const

inlineinherited

Obtain the constant iterator pointing to the last dof.

Returns: Constant iterator pointing to the last dof

◆ dofsValid()

bool Dune::Fem::DiscreteFunctionDefault< TupleDiscreteFunction< DiscreteFunctions ... > >::dofsValid

inlineinherited

check for NaNs

Returns: if one of the DoFs is NaN false is returned, otherwise true

◆ enableDofCompression()

template<class ... DiscreteFunctions>

void Dune::Fem::TupleDiscreteFunction< DiscreteFunctions >::enableDofCompression ( )

inline

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

References Dune::Hybrid::forEach().

Referenced by Dune::Fem::LoadBalancer< GridType >::addDiscreteFunction().

◆ endAssemble()

void Dune::Fem::DiscreteFunctionDefault< TupleDiscreteFunction< DiscreteFunctions ... > >::endAssemble ( const bool communicate = true )

inlineinherited

Finalize the assemble of values using the LocalContribution concept.

Template Parameters

AssembleOperation the specific operation (Add, Set, ...)

◆ evaluate()

void Dune::Fem::DiscreteFunctionDefault< TupleDiscreteFunction< DiscreteFunctions ... > >::evaluate	(	const DomainType &	x,
		RangeType &	value
	)		const

inlineinherited

evaluate the function

Parameters

[in]	x	evaluation point
[out]	value	value of the function in x

◆ getLocalDofs() [1/2]

void Dune::Fem::DiscreteFunctionInterface< TupleDiscreteFunction< DiscreteFunctions ... > >::getLocalDofs	(	const EntityType &	entity,
		Vector &	localDofs
	)		const

inlineinherited

fill local Dofs to dof vector associated with the entity

Parameters

[in]	entity	Entity to focus view of discrete function
[out]	localDofs	the local dofs vector to be set

Note: localDofs should have sufficient size to store the dof values

◆ getLocalDofs() [2/2]

void Dune::Fem::DiscreteFunctionDefault< TupleDiscreteFunction< DiscreteFunctions ... > >::getLocalDofs	(	const EntityType &	entity,
		Vector &	localDofs
	)		const

inlineinherited

fill local Dofs to dof vector associated with the entity

Parameters

[in]	entity	Entity to focus view of discrete function
[out]	localDofs	the local dofs vector to be set

Note: localDofs should have sufficient size to store the dof values

◆ hessian() [1/2]

void Dune::Fem::DiscreteFunctionDefault< TupleDiscreteFunction< DiscreteFunctions ... > >::hessian	(	const DomainType &	x,
		HessianRangeType &	hessian
	)		const

inlineinherited

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

Parameters

[in]	x	evaluation point
[out]	hessian	value of the hessian in x (const DomainType &x,HessianRangeType &hessian) const

◆ hessian() [2/2]

void Dune::Fem::Function< DiscreteFunctionTraits< TupleDiscreteFunction< DiscreteFunctions ... > >::DiscreteFunctionSpaceType::FunctionSpaceType , TupleDiscreteFunction< DiscreteFunctions ... > >::hessian	(	const DomainType &	x,
		HessianRangeType &	hessian
	)		const

inlineinherited

evaluate the hessian of the function

Parameters

[in]	x	evaluation point
[out]	hessian	value of the hessian in x

◆ insertSubData()

void Dune::Fem::DiscreteFunctionDefault< TupleDiscreteFunction< DiscreteFunctions ... > >::insertSubData

protectedvirtualinherited

Reimplemented from Dune::Fem::PersistentObject.

◆ jacobian() [1/2]

void Dune::Fem::DiscreteFunctionDefault< TupleDiscreteFunction< DiscreteFunctions ... > >::jacobian	(	const DomainType &	x,
		JacobianRangeType &	jacobian
	)		const

inlineinherited

evaluate the Jacobian of the function

Parameters

[in]	x	evaluation point
[out]	jacobian	value of the Jacobian in x

◆ jacobian() [2/2]

void Dune::Fem::Function< DiscreteFunctionTraits< TupleDiscreteFunction< DiscreteFunctions ... > >::DiscreteFunctionSpaceType::FunctionSpaceType , TupleDiscreteFunction< DiscreteFunctions ... > >::jacobian	(	const DomainType &	x,
		JacobianRangeType &	jacobian
	)		const

inlineinherited

evaluate the Jacobian of the function

Parameters

[in]	x	evaluation point
[out]	jacobian	value of the Jacobian in x

◆ localDofVectorAllocator()

LocalDofVectorAllocatorType& Dune::Fem::DiscreteFunctionDefault< TupleDiscreteFunction< DiscreteFunctions ... > >::localDofVectorAllocator ( ) const

inlineinherited

obtain the local function storage

Returns: a reference to the local function storage

◆ localFunction() [1/6]

LocalFunctionType Dune::Fem::DiscreteFunctionDefault< TupleDiscreteFunction< DiscreteFunctions ... > >::localFunction ( )

inlineinherited

obtain an uninitialized local function (read-write)

Note: before calling any method of the local function initialize it passing an entity

Returns: an uninitialized local function

◆ localFunction() [2/6]

const LocalFunctionType Dune::Fem::DiscreteFunctionDefault< TupleDiscreteFunction< DiscreteFunctions ... > >::localFunction ( ) const

inlineinherited

obtain an uninitialized local function (read-write)

Note: before calling any method of the local function initialize it passing an entity

Returns: an uninitialized local function

◆ localFunction() [3/6]

LocalFunctionType Dune::Fem::DiscreteFunctionInterface< TupleDiscreteFunction< DiscreteFunctions ... > >::localFunction ( const EntityType & entity )

inlineinherited

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

Parameters

[in] entity Entity to focus view of discrete function

Returns: a local function associated with the entity

◆ localFunction() [4/6]

LocalFunctionType Dune::Fem::DiscreteFunctionDefault< TupleDiscreteFunction< DiscreteFunctions ... > >::localFunction ( const EntityType & entity )

inlineinherited

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

Parameters

[in] entity Entity to focus view of discrete function

Returns: a local function associated with the entity

◆ localFunction() [5/6]

const LocalFunctionType Dune::Fem::DiscreteFunctionInterface< TupleDiscreteFunction< DiscreteFunctions ... > >::localFunction ( const EntityType & entity ) const

inlineinherited

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

Parameters

[in] entity Entity to focus view of discrete function

Returns: a local function associated with the entity

◆ localFunction() [6/6]

const LocalFunctionType Dune::Fem::DiscreteFunctionDefault< TupleDiscreteFunction< DiscreteFunctions ... > >::localFunction ( const EntityType & entity ) const

inlineinherited

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

Parameters

[in] entity Entity to focus view of discrete function

Returns: a local function associated with the entity

◆ name() [1/2]

std::string& Dune::Fem::DiscreteFunctionDefault< TupleDiscreteFunction< DiscreteFunctions ... > >::name ( )

inlineinherited

obtain the name of the discrete function

Returns: string holding name of discrete function

◆ name() [2/2]

const std::string& Dune::Fem::DiscreteFunctionDefault< TupleDiscreteFunction< DiscreteFunctions ... > >::name ( ) const

inlineinherited

obtain the name of the discrete function

Returns: string holding name of discrete function

◆ normSquaredDofs()

Dune::FieldTraits< RangeFieldType >::real_type Dune::Fem::DiscreteFunctionDefault< TupleDiscreteFunction< DiscreteFunctions ... > >::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

◆ operator()()

virtual void Dune::Fem::Function< DiscreteFunctionTraits< TupleDiscreteFunction< DiscreteFunctions ... > >::DiscreteFunctionSpaceType::FunctionSpaceType , TupleDiscreteFunction< DiscreteFunctions ... > >::operator()	(	const DomainType &	arg,
		RangeType &	dest
	)		const

inlinevirtualinherited

application operator call evaluate

Parameters

[in]	arg	argument
[out]	dest	destination, i.e. f(arg)

◆ operator*=()

DiscreteFunctionType& Dune::Fem::DiscreteFunctionDefault< TupleDiscreteFunction< DiscreteFunctions ... > >::operator*= ( const RangeFieldType & scalar )

inlineinherited

multiply all DoFs with a scalar factor

Parameters

[in] scalar factor to multiply DoFs with

Returns: reference to this discrete function (i.e. *this)

◆ operator+=() [1/2]

DiscreteFunctionDefault< TupleDiscreteFunction< DiscreteFunctions ... > >::DiscreteFunctionType & Dune::Fem::DiscreteFunctionDefault< TupleDiscreteFunction< DiscreteFunctions ... > >::operator+= ( const DiscreteFunctionInterface< DFType > & g )

inlineinherited

add another discrete function to this one

Parameters

[in] g discrete function to add

Returns: a reference to this discrete function (i.e. *this)

◆ operator+=() [2/2]

DiscreteFunctionType& Dune::Fem::DiscreteFunctionDefault< TupleDiscreteFunction< DiscreteFunctions ... > >::operator+= ( const DiscreteFunctionType & g )

inlineinherited

add another discrete function to this one

Parameters

[in] g discrete function to add

Returns: a reference to this discrete function (i.e. *this)

◆ operator-=() [1/2]

DiscreteFunctionDefault< TupleDiscreteFunction< DiscreteFunctions ... > >::DiscreteFunctionType & Dune::Fem::DiscreteFunctionDefault< TupleDiscreteFunction< DiscreteFunctions ... > >::operator-= ( const DiscreteFunctionInterface< DFType > & g )

inlineinherited

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

Parameters

[in] g discrete function which is substracted from this discrete function

Returns: reference to this (i.e. *this)

◆ operator-=() [2/2]

DiscreteFunctionType& Dune::Fem::DiscreteFunctionDefault< TupleDiscreteFunction< DiscreteFunctions ... > >::operator-= ( const DiscreteFunctionType & g )

inlineinherited

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

Parameters

[in] g discrete function which is substracted from this discrete function

Returns: reference to this (i.e. *this)

◆ operator/=()

DiscreteFunctionType& Dune::Fem::DiscreteFunctionDefault< TupleDiscreteFunction< DiscreteFunctions ... > >::operator/= ( const RangeFieldType & scalar )

inlineinherited

devide all DoFs by a scalar factor

Parameters

[in] scalar factor with which all dofs are devided

Returns: reference to this discrete function (i.e. *this)

◆ order()

constexpr int Dune::Fem::DiscreteFunctionDefault< TupleDiscreteFunction< DiscreteFunctions ... > >::order ( ) const

inlineconstexprinherited

obtain an upper bound on the polynomial order of the underlying space.

◆ print()

void Dune::Fem::DiscreteFunctionDefault< TupleDiscreteFunction< DiscreteFunctions ... > >::print ( std ::ostream & out ) const

inlineinherited

print all DoFs to a stream (for debugging purposes)

Parameters

[in] out stream to print to

◆ read()

void Dune::Fem::DiscreteFunctionDefault< TupleDiscreteFunction< DiscreteFunctions ... > >::read ( InStreamInterface< StreamTraits > & in )

inlineinherited

read the discrete function from a stream

Parameters

[in] in stream to read the discrete function from

Note: This call will automatically enable dof compression for this discrete function.

◆ removeSubData()

void Dune::Fem::DiscreteFunctionDefault< TupleDiscreteFunction< DiscreteFunctions ... > >::removeSubData

protectedvirtualinherited

Reimplemented from Dune::Fem::PersistentObject.

◆ restore()

virtual void Dune::Fem::DiscreteFunctionDefault< TupleDiscreteFunction< DiscreteFunctions ... > >::restore ( )

inlineprotectedvirtualinherited

Implements Dune::Fem::PersistentObject.

◆ scalarProductDofs()

RangeFieldType Dune::Fem::DiscreteFunctionDefault< TupleDiscreteFunction< DiscreteFunctions ... > >::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] other discrete function to evaluate the scalar product with

Returns: the scalar product of the DoF-vectors

◆ setLocalDofs() [1/2]

void Dune::Fem::DiscreteFunctionInterface< TupleDiscreteFunction< DiscreteFunctions ... > >::setLocalDofs	(	const EntityType &	entity,
		const LocalDofs &	localDofs
	)

inlineinherited

set local Dofs to dof vector associated with the entity

Parameters

[in]	entity	Entity to focus view of discrete function
[in]	localDofs	the local dofs vector to be set

◆ setLocalDofs() [2/2]

void Dune::Fem::DiscreteFunctionDefault< TupleDiscreteFunction< DiscreteFunctions ... > >::setLocalDofs	(	const EntityType &	entity,
		const LocalDofs &	localDofs
	)

inlineinherited

set local Dofs to dof vector associated with the entity

Parameters

[in]	entity	Entity to focus view of discrete function
[in]	localDofs	the local dofs vector to be set

◆ size()

SizeType Dune::Fem::DiscreteFunctionDefault< TupleDiscreteFunction< DiscreteFunctions ... > >::size ( ) const

inlineinherited

Return the number of blocks in the block vector.

Returns: Number of block in the block vector

◆ space() [1/2]

const DiscreteFunctionSpaceType& Dune::Fem::DiscreteFunctionDefault< TupleDiscreteFunction< DiscreteFunctions ... > >::space ( ) const

inlineinherited

obtain a reference to the corresponding DiscreteFunctionSpace

◆ space() [2/2]

template<class ... DiscreteFunctions>

const DiscreteFunctionSpaceType& Dune::Fem::DiscreteFunctionDefault< Impl >::space

inline

obtain a reference to the corresponding DiscreteFunctionSpace

Referenced by Dune::Fem::LocalDataInliner< DiscreteFunctionType, ContainsCheck >::apply(), Dune::Fem::LocalDataXtractor< DiscreteFunctionType, ContainsCheck >::apply(), Dune::Fem::LocalDataInliner< DiscreteFunctionType, ContainsCheck >::inlineData(), Dune::Fem::HdivProjection< DiscreteFunctionType >::normalJump(), and Dune::Fem::LocalDataXtractor< DiscreteFunctionType, ContainsCheck >::xtractData().

◆ write()

void Dune::Fem::DiscreteFunctionDefault< TupleDiscreteFunction< DiscreteFunctions ... > >::write ( OutStreamInterface< StreamTraits > & out ) const

inlineinherited

write the discrete function into a stream

Parameters

[in] out stream to write the discrete function to

Friends And Related Function Documentation

◆ operator*() [1/2]

template<class DFieldType , class RFieldType , class DType , class RType >

static Mapping< DFieldType, RFieldType, DType, RType > operator*	(	const Mapping< DFieldType, RFieldType, DType, RType > &	mapping,
		const RFieldType &	factor
	)

Parameters

[in]	mapping	Mapping which is scaled
[in]	factor	factor with which mapping is scaled

Returns: new object mapping

References Dune::Fem::MappingOperators::multiplyMapping().

◆ operator*() [2/2]

template<class DFieldType , class RFieldType , class DType , class RType >

static Mapping< DFieldType, RFieldType, DType, RType > operator*	(	const RFieldType &	factor,
		const Mapping< DFieldType, RFieldType, DType, RType > &	mapping
	)

Parameters

[in]	factor	factor with which mapping is scaled
[in]	mapping	Mapping which is scaled

Returns: new object mapping

References Dune::Fem::MappingOperators::multiplyMapping().

◆ operator+()

template<class DFieldType , class RFieldType , class DType , class RType >

static Mapping< DFieldType, RFieldType, DType, RType > operator+	(	const Mapping< DFieldType, RFieldType, DType, RType > &	a,
		const Mapping< DFieldType, RFieldType, DType, RType > &	b
	)

Parameters

[in]	a	mapping 1
[in]	b	mapping 2

Returns: new object mapping

References Dune::Fem::MappingOperators::addMappings().

◆ operator-()

template<class DFieldType , class RFieldType , class DType , class RType >

static Mapping< DFieldType, RFieldType, DType, RType > operator-	(	const Mapping< DFieldType, RFieldType, DType, RType > &	a,
		const Mapping< DFieldType, RFieldType, DType, RType > &	b
	)

Parameters

[in]	a	mapping 1
[in]	b	mapping 2

Returns: new object mapping

References Dune::Fem::MappingOperators::substractMappings().

◆ operator/() [1/2]

template<class DFieldType , class RFieldType , class DType , class RType >

static Mapping< DFieldType, RFieldType, DType, RType > operator/	(	const Mapping< DFieldType, RFieldType, DType, RType > &	mapping,
		const RFieldType &	factor
	)

Parameters

[in]	mapping	mapping which is divided
[in]	factor	f factor by which result of mapping is divided

Returns: new object mapping

References Dune::Fem::MappingOperators::divideMapping().

◆ operator/() [2/2]

template<class DFieldType , class RFieldType , class DType , class RType >

static Mapping< DFieldType, RFieldType, DType, RType > operator/	(	const RFieldType &	factor,
		const Mapping< DFieldType, RFieldType, DType, RType > &	mapping
	)

Parameters

[in]	factor	by which result of mapping is divided
[in]	mapping	which is divided

Returns: new object mapping

References Dune::Fem::MappingOperators::divideMapping().

◆ operator<<()

std::ostream & operator<<	(	std ::ostream &	out,
		const DiscreteFunctionInterface< TupleDiscreteFunction< DiscreteFunctions ... > > &	df
	)

Parameters

[in]	out	STL stream to write to
[in]	df	discrete function to write

Returns: the STL stream (for concatenation)

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

dune/fem/function/tuplediscretefunction/discretefunction.hh

Classes

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Related Functions

Detailed Description

template<class ... DiscreteFunctions> class Dune::Fem::TupleDiscreteFunction< DiscreteFunctions >

Constructor & Destructor Documentation

◆ TupleDiscreteFunction() [1/2]

◆ TupleDiscreteFunction() [2/2]

Member Function Documentation

◆ addLocalDofs() [1/2]

◆ addLocalDofs() [2/2]

◆ addScaledLocalDofs() [1/2]

◆ addScaledLocalDofs() [2/2]

◆ assign() [1/2]

◆ assign() [2/2]

◆ axpy() [1/2]

◆ axpy() [2/2]

◆ backup()

◆ beginAssemble()

◆ block() [1/2]

◆ block() [2/2]

◆ blocks()

◆ clear()

◆ communicate()

◆ continuous()

◆ dataHandle()

◆ dbegin() [1/2]

◆ dbegin() [2/2]

◆ dend() [1/2]

◆ dend() [2/2]

◆ dofsValid()

◆ enableDofCompression()

◆ endAssemble()

◆ evaluate()

◆ getLocalDofs() [1/2]

◆ getLocalDofs() [2/2]

◆ hessian() [1/2]

◆ hessian() [2/2]

◆ insertSubData()

◆ jacobian() [1/2]

◆ jacobian() [2/2]

◆ localDofVectorAllocator()

◆ localFunction() [1/6]

◆ localFunction() [2/6]

◆ localFunction() [3/6]

◆ localFunction() [4/6]

◆ localFunction() [5/6]

◆ localFunction() [6/6]

◆ name() [1/2]

◆ name() [2/2]

◆ normSquaredDofs()

◆ operator()()

◆ operator*=()

◆ operator+=() [1/2]

◆ operator+=() [2/2]

◆ operator-=() [1/2]

◆ operator-=() [2/2]

◆ operator/=()

◆ order()

◆ print()

◆ read()

◆ removeSubData()

◆ restore()

◆ scalarProductDofs()

◆ setLocalDofs() [1/2]

◆ setLocalDofs() [2/2]

◆ size()

◆ space() [1/2]

◆ space() [2/2]

◆ write()

Friends And Related Function Documentation

◆ operator*() [1/2]

◆ operator*() [2/2]

◆ operator+()

◆ operator-()

◆ operator/() [1/2]

◆ operator/() [2/2]

template<class ... DiscreteFunctions>
class Dune::Fem::TupleDiscreteFunction< DiscreteFunctions >