Please doc me. More...

#include <dune/fem/space/padaptivespace/generic.hh>

Public Types
typedef int	IdentifierType
	type of identifier for this discrete function space

typedef DofManager< GridType >	DofManagerType
	type of DoF manager

typedef CommunicationManager< DiscreteFunctionSpaceType >	CommunicationManagerType
	type of communication manager

typedef AuxiliaryDofsType	SlaveDofsType
	deprecated type

Public Member Functions
	GenericDiscreteFunctionSpace (GridPartType &gridPart, const int order, const InterfaceType commInterface, const CommunicationDirection commDirection)
	constructor More...

DFSpaceIdentifier	type () const
	return type identifier of discrete function space More...

BasisFunctionSetType	basisFunctionSet (const EntityType &entity) const
	get basis function set for given entity More...

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

int	order () const
	get global order of space More...

int	order (const typename BaseType::EntityType &entity) const
	get global order of space More...

bool	multipleBaseFunctionSets () const
	this space has more than one base function set

BlockMapperType &	blockMapper () const
	get a reference to the block mapper More...

ShapeFunctionSetType	shapeFunctionSet (const EntityType &entity) const
	return shape function set for given entity More...

ShapeFunctionSetType	shapeFunctionSet (const GeometryType &type, const int order=polynomialOrder) const
	return shape unique function set for geometry type More...

template<class EntityType >
const CompiledLocalKeyType &	compiledLocalKey (const EntityType &entity) const
	provide access to the compiled local keys for an entity More...

const CompiledLocalKeyType &	compiledLocalKey (const GeometryType type, const int order=polynomialOrder) const
	provide access to the compiled local keys for a geometry type and polynomial order More...

int	sequence () const
	get index of the sequence in grid sequences More...

int	order (const EntityType &entity) const
	default implementation of the method order More...

const GridType &	grid () const
	get reference to grid this discrete function space belongs to More...

GridType &	grid ()
	get reference to grid this discrete function space belongs to More...

GridPartType &	gridPart () const

GridPartType &	gridPart ()
	get a reference to the associated grid partition More...

const IndexSetType &	indexSet () const
	Get a reference to the associated index set. More...

int	size () const
	get number of DoFs for this space More...

int	primarySize () const
	get number of primary DoFs for this space More...

int	auxiliarySize () const
	get number of auxiliary DoFs for this space More...

int	maxNumDofs () const
	return the maximal number of dofs on entities

IteratorType	begin () const
	get iterator pointing to the first entity of the associated grid partition More...

IteratorType	end () const
	get iterator pointing behind the last entity of the associated grid partition More...

void	forEach (FunctorType &f) const
	apply a functor to each entity in the associated grid partition More...

bool	multipleGeometryTypes () const
	returns true if the grid has more than one geometry type More...

bool	multipleBasisFunctionSets () const
	returns true if base function sets depend on the entity More...

InterfaceType	communicationInterface () const
	return the communication interface appropriate for this space More...

CommunicationDirection	communicationDirection () const
	return the communication interface appropriate for this space More...

const CommunicationManagerType &	communicator () const
	return reference to communicator (see CommunicationManager) More...

void	communicate (DiscreteFunction &discreteFunction) const
	communicate data for given discrete function using the space's default communication operation More...

void	communicate (DiscreteFunction &discreteFunction, const Operation &op) const
	communicate data for given discrete function More...

BaseType::template CommDataHandle< DiscreteFunction, Operation >::Type	createDataHandle (DiscreteFunction &discreteFunction, const Operation &operation) const

const AuxiliaryDofsType &	auxiliaryDofs () const
	get auxiliary dofs

void	addFunction (DiscreteFunction &df) const
	default implementation of addFunction does nothing at the moment

void	removeFunction (DiscreteFunction &df) const
	default implementation of removeFunction does nothing at the moment

void	adapt (const Vector &polynomialOrders, const int polOrderShift=0) const
	default implementation of adapt does nothing, its only used in PAdaptiveLagrangeSpace

const std::vector< GeometryType > &	geomTypes (int codim) const
	returns true if the grid has more than one geometry type More...

const BasisFunctionSetType	basisFunctionSet (const EntityType &entity) const
	get basis function set for given entity More...

bool	continuous (const IntersectionType &intersection) const
	returns true if discrete functions over this space have zero jump over the given intersection. More...

const AuxiliaryDofsType &	slaveDofs () const
	deprecated method, use auxiliaryDofs

Adaptation
KeyType	key (const EntityType &entity) const
	get identifiying basis function set key assigned to given entity More...

void	mark (const KeyType &key, const EntityType &entity)
	assign new key to given entity More...

KeyType	getMark (const EntityType &entity) const
	get key to be assigned to an entity after next call to adapt() More...

void	adapt ()
	p adaptation More...

template<class DiscreteFunctionSpace , class Implementation >
void	adapt (DataProjection< DiscreteFunctionSpace, Implementation > &projection)

Static Public Attributes
static const int	polynomialOrder = Traits::polynomialOrder
	maximal available polynomial order

static const IdentifierType	id = 665
	identifier of this discrete function space

static constexpr std::size_t	localBlockSize
	size of local blocks

Related Functions
(Note that these are not member functions.)
bool	operator== (const DiscreteFunctionSpaceInterface< Traits > &X, const DiscreteFunctionSpaceInterface< Traits > &Y)
	check two spaces for equality More...

Detailed Description

template<class Traits>
class Dune::Fem::GenericDiscreteFunctionSpace< Traits >

Please doc me.

Constructor & Destructor Documentation

◆ GenericDiscreteFunctionSpace()

template<class Traits >

Dune::Fem::GenericDiscreteFunctionSpace< Traits >::GenericDiscreteFunctionSpace	(	GridPartType &	gridPart,
		const int	order,
		const InterfaceType	commInterface,
		const CommunicationDirection	commDirection
	)

inline

constructor

Parameters

[in]	gridPart	grid part
[in]	commInterface	communication interface to use
[in]	commDirection	communication direction to use

Member Function Documentation

◆ adapt()

template<class Traits >

void Dune::Fem::GenericDiscreteFunctionSpace< Traits >::adapt ( )

inline

p adaptation

Parameters

[in]	function	oialOrders vector containing polynomial orders for each cell
[in]	polOrderShift	possible shift of polynomial order (i.e. in case of Taylor-Hood put -1 for the pressure) (default = 0)

References Dune::Fem::GenericDiscreteFunctionSpace< Traits >::blockMapper(), Dune::Fem::DofManager< Grid >::compress(), and Dune::Fem::DofManager< Grid >::resize().

◆ auxiliarySize()

int Dune::Fem::DiscreteFunctionSpaceDefault< Traits >::auxiliarySize ( ) const

inlineinherited

get number of auxiliary DoFs for this space

Returns: number of auxiliary DoFs (degrees of freedom that are NOT owned by this process)

◆ basisFunctionSet() [1/2]

const BasisFunctionSetType Dune::Fem::DiscreteFunctionSpaceInterface< Traits >::basisFunctionSet ( const EntityType & entity ) const

inlineinherited

get basis function set for given entity

Parameters

[in] entity entity (of codim 0) for which base function is requested

Returns: BasisFunctionSet for the entity

◆ basisFunctionSet() [2/2]

template<class Traits >

BasisFunctionSetType Dune::Fem::GenericDiscreteFunctionSpace< Traits >::basisFunctionSet ( const EntityType & entity ) const

inline

get basis function set for given entity

Parameters

[in] entity entity (of codim 0) for which base function is requested

Returns: BasisFunctionSet for the entity

◆ begin()

IteratorType Dune::Fem::DiscreteFunctionSpaceDefault< Traits >::begin ( ) const

inlineinherited

get iterator pointing to the first entity of the associated grid partition

Returns: iterator pointing to first entity

Note: The default implementation uses the codim 0 iterators of the associated grid partition.

◆ blockMapper()

template<class Traits >

BlockMapperType & Dune::Fem::GenericDiscreteFunctionSpace< Traits >::blockMapper ( ) const

inline

get a reference to the block mapper

Returns: refernce to the block mapper

Referenced by Dune::Fem::GenericDiscreteFunctionSpace< Traits >::adapt(), Dune::Fem::GenericDiscreteFunctionSpace< Traits >::getMark(), Dune::Fem::GenericDiscreteFunctionSpace< Traits >::key(), Dune::Fem::GenericDiscreteFunctionSpace< Traits >::mark(), and Dune::Fem::GenericDiscreteFunctionSpace< Traits >::order().

◆ communicate() [1/2]

void Dune::Fem::DiscreteFunctionSpaceDefault< Traits >::communicate ( DiscreteFunction & discreteFunction ) const

inlineinherited

communicate data for given discrete function using the space's default communication operation

Parameters

discreteFunction discrete function to be communicated

◆ communicate() [2/2]

void Dune::Fem::DiscreteFunctionSpaceDefault< Traits >::communicate	(	DiscreteFunction &	discreteFunction,
		const Operation &	op
	)		const

inlineinherited

communicate data for given discrete function

Parameters

	discreteFunction	discrete function to be communicated
[in]	op	communication operation to use (see DFCommunicationOperation)

◆ communicationDirection()

CommunicationDirection Dune::Fem::DiscreteFunctionSpaceDefault< Traits >::communicationDirection ( ) const

inlineinherited

return the communication interface appropriate for this space

Returns: communication interface

◆ communicationInterface()

InterfaceType Dune::Fem::DiscreteFunctionSpaceDefault< Traits >::communicationInterface ( ) const

inlineinherited

return the communication interface appropriate for this space

Returns: communication interface

◆ communicator()

const CommunicationManagerType & Dune::Fem::DiscreteFunctionSpaceDefault< Traits >::communicator ( ) const

inlineinherited

return reference to communicator (see CommunicationManager)

Returns: reference to communicator

◆ compiledLocalKey() [1/2]

template<class Traits >

template<class EntityType >

const CompiledLocalKeyType & Dune::Fem::GenericDiscreteFunctionSpace< Traits >::compiledLocalKey ( const EntityType & entity ) const

inline

provide access to the compiled local keys for an entity

Note: This method is not part of the DiscreteFunctionSpaceInterface. It is unique to the GenericDiscreteFunctionSpace.

Parameters

[in] entity entity the Lagrange point set is requested for

Returns: CompiledLocalKey

References Dune::Fem::GenericDiscreteFunctionSpace< Traits >::compiledLocalKey(), and Dune::Fem::GenericDiscreteFunctionSpace< Traits >::order().

Referenced by Dune::Fem::GenericDiscreteFunctionSpace< Traits >::compiledLocalKey().

◆ compiledLocalKey() [2/2]

template<class Traits >

const CompiledLocalKeyType & Dune::Fem::GenericDiscreteFunctionSpace< Traits >::compiledLocalKey	(	const GeometryType	type,
		const int	order = `polynomialOrder`
	)		const

inline

provide access to the compiled local keys for a geometry type and polynomial order

Note: This method is not part of the DiscreteFunctionSpaceInterface. It is unique to the GenericDiscreteFunctionSpace.

Parameters

[in]	type	type of geometry the compiled local key is requested for
[in]	order	polynomial order for given geometry type

Returns: CompiledLocalKey

References Dune::Fem::GenericDiscreteFunctionSpace< Traits >::order(), and Dune::Fem::GenericDiscreteFunctionSpace< Traits >::type().

◆ continuous() [1/2]

template<class Traits >

bool Dune::Fem::GenericDiscreteFunctionSpace< Traits >::continuous ( ) const

inline

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

◆ continuous() [2/2]

bool Dune::Fem::DiscreteFunctionSpaceInterface< Traits >::continuous ( const IntersectionType & intersection ) const

inlineinherited

returns true if discrete functions over this space have zero jump over the given intersection.

For example, a Lagrange space returns true iff the intersection is conforming while a discontiuous Galerkin space always returns false.

Parameters

intersection Intersection for which we want to know the continuety

Returns: true if the space contians functions which are continuous over the intersection, false otherwise

◆ createDataHandle()

BaseType::template CommDataHandle< DiscreteFunction, Operation >::Type Dune::Fem::DiscreteFunctionSpaceDefault< Traits >::createDataHandle	(	DiscreteFunction &	discreteFunction,
		const Operation &	operation
	)		const

inlineinherited

Note: The default implementation is
return CommDataHandle< DiscreteFunction, Operation > :: Type( discreteFunction );

◆ end()

IteratorType Dune::Fem::DiscreteFunctionSpaceDefault< Traits >::end ( ) const

inlineinherited

get iterator pointing behind the last entity of the associated grid partition

Returns: iterator pointing behind last entity

Note: The default implementation uses the codim 0 iterators of the associated grid partition.

◆ forEach()

void Dune::Fem::DiscreteFunctionSpaceDefault< Traits >::forEach ( FunctorType & f ) const

inlineinherited

apply a functor to each entity in the associated grid partition

The functor must provide an the following operator

template< class EntityType >

void operator() ( const EntityType & );

Parameters

[in] f functor to apply

Note: The default implementation simply does the following:
const IteratorType end = asImp().end();

for( IteratorType it = asImp().begin(); it != end; ++it )

f( *it );

Dune::Fem::DiscreteFunctionSpaceDefault< Traits >::end
IteratorType end() const
get iterator pointing behind the last entity of the associated grid partition
Definition: discretefunctionspace.hh:817

Dune::Fem::DiscreteFunctionSpaceDefault< Traits >::begin
IteratorType begin() const
get iterator pointing to the first entity of the associated grid partition
Definition: discretefunctionspace.hh:807

◆ geomTypes()

const std::vector< GeometryType > & Dune::Fem::DiscreteFunctionSpaceDefault< Traits >::geomTypes ( int codim ) const

inlineinherited

returns true if the grid has more than one geometry type

Returns: true if the underlying grid has more than one geometry type (hybrid grid), false otherwise

◆ getMark()

template<class Traits >

KeyType Dune::Fem::GenericDiscreteFunctionSpace< Traits >::getMark ( const EntityType & entity ) const

inline

get key to be assigned to an entity after next call to adapt()

Parameters

[in] entity grid part entity

Returns: key

References Dune::Fem::GenericDiscreteFunctionSpace< Traits >::blockMapper().

◆ grid() [1/2]

GridType & Dune::Fem::DiscreteFunctionSpaceDefault< Traits >::grid ( )

inlineinherited

get reference to grid this discrete function space belongs to

Returns: reference to grid

◆ grid() [2/2]

const GridType & Dune::Fem::DiscreteFunctionSpaceDefault< Traits >::grid ( ) const

inlineinherited

get reference to grid this discrete function space belongs to

Returns: constant reference to grid

◆ gridPart() [1/2]

GridPartType & Dune::Fem::DiscreteFunctionSpaceInterface< Traits >::gridPart ( )

inlineinherited

get a reference to the associated grid partition

Returns: reference to the grid partition

◆ gridPart() [2/2]

GridPartType & Dune::Fem::DiscreteFunctionSpaceDefault< Traits >::gridPart ( ) const

inlineinherited

◆ indexSet()

const IndexSetType & Dune::Fem::DiscreteFunctionSpaceDefault< Traits >::indexSet ( ) const

inlineinherited

Get a reference to the associated index set.

Returns: const reference to index set

◆ key()

template<class Traits >

KeyType Dune::Fem::GenericDiscreteFunctionSpace< Traits >::key ( const EntityType & entity ) const

inline

get identifiying basis function set key assigned to given entity

Parameters

[in] entity grid part entity

Returns: key

References Dune::Fem::GenericDiscreteFunctionSpace< Traits >::blockMapper().

Referenced by Dune::Fem::GenericDiscreteFunctionSpace< Traits >::mark().

◆ mark()

template<class Traits >

void Dune::Fem::GenericDiscreteFunctionSpace< Traits >::mark	(	const KeyType &	key,
		const EntityType &	entity
	)

inline

assign new key to given entity

Parameters

[in]	key	key identifying basis function set
[in]	entity	grid part entity

References Dune::Fem::GenericDiscreteFunctionSpace< Traits >::blockMapper(), and Dune::Fem::GenericDiscreteFunctionSpace< Traits >::key().

◆ multipleBasisFunctionSets()

bool Dune::Fem::DiscreteFunctionSpaceDefault< Traits >::multipleBasisFunctionSets ( ) const

inlineinherited

returns true if base function sets depend on the entity

Returns: true if base function set depend on entities, false otherwise

Note: The default implementation returns false.

◆ multipleGeometryTypes()

bool Dune::Fem::DiscreteFunctionSpaceDefault< Traits >::multipleGeometryTypes ( ) const

inlineinherited

returns true if the grid has more than one geometry type

Returns: true if the underlying grid has more than one geometry type (hybrid grid), false otherwise

◆ order() [1/3]

template<class Traits >

int Dune::Fem::GenericDiscreteFunctionSpace< Traits >::order ( ) const

inline

get global order of space

Returns: order of space, i.e., the maximal polynomial order of base functions

Referenced by Dune::Fem::GenericDiscreteFunctionSpace< Traits >::compiledLocalKey(), and Dune::Fem::GenericDiscreteFunctionSpace< Traits >::shapeFunctionSet().

◆ order() [2/3]

int Dune::Fem::DiscreteFunctionSpaceDefault< Traits >::order ( const EntityType & entity ) const

inlineinherited

default implementation of the method order

Returns: returns max polynomial order for each entity using the method order()

◆ order() [3/3]

template<class Traits >

int Dune::Fem::GenericDiscreteFunctionSpace< Traits >::order ( const typename BaseType::EntityType & entity ) const

inline

get global order of space

Returns: order of space, i.e., the maximal polynomial order of base functions

References Dune::Fem::GenericDiscreteFunctionSpace< Traits >::blockMapper().

◆ primarySize()

int Dune::Fem::DiscreteFunctionSpaceDefault< Traits >::primarySize ( ) const

inlineinherited

get number of primary DoFs for this space

Returns: number of primary DoFs (degrees of freedom that are owned by this process )

◆ sequence()

int Dune::Fem::DiscreteFunctionSpaceDefault< Traits >::sequence ( ) const

inlineinherited

get index of the sequence in grid sequences

Returns: number of current sequence

◆ shapeFunctionSet() [1/2]

template<class Traits >

ShapeFunctionSetType Dune::Fem::GenericDiscreteFunctionSpace< Traits >::shapeFunctionSet ( const EntityType & entity ) const

inline

return shape function set for given entity

Parameters

[in] entity entity (of codim 0) for which shape function set is requested

Returns: ShapeFunctionSetType shape function set

References Dune::Fem::GenericDiscreteFunctionSpace< Traits >::order(), and Dune::Fem::GenericDiscreteFunctionSpace< Traits >::shapeFunctionSet().

Referenced by Dune::Fem::GenericDiscreteFunctionSpace< Traits >::shapeFunctionSet().

◆ shapeFunctionSet() [2/2]

template<class Traits >

ShapeFunctionSetType Dune::Fem::GenericDiscreteFunctionSpace< Traits >::shapeFunctionSet	(	const GeometryType &	type,
		const int	order = `polynomialOrder`
	)		const

inline

return shape unique function set for geometry type

Parameters

[in]	type	geometry type (must be a cube) for which shape function set is requested
[in]	order	polynomial order

Returns: ShapeFunctionSetType shape function set

References Dune::Fem::GenericDiscreteFunctionSpace< Traits >::order(), and Dune::Fem::GenericDiscreteFunctionSpace< Traits >::type().

◆ size()

int Dune::Fem::DiscreteFunctionSpaceDefault< Traits >::size ( ) const

inlineinherited

get number of DoFs for this space

Returns: number of DoFs (degrees of freedom)

◆ type()

template<class Traits >

DFSpaceIdentifier Dune::Fem::GenericDiscreteFunctionSpace< Traits >::type ( ) const

inline

return type identifier of discrete function space

Returns: return type identifier of discrete function space

References Dune::Fem::GenericSpace_id.

Referenced by Dune::Fem::GenericDiscreteFunctionSpace< Traits >::compiledLocalKey(), and Dune::Fem::GenericDiscreteFunctionSpace< Traits >::shapeFunctionSet().

Friends And Related Function Documentation

◆ operator==()

bool operator==	(	const DiscreteFunctionSpaceInterface< Traits > &	X,
		const DiscreteFunctionSpaceInterface< Traits > &	Y
	)

This is a default implemented equality operator for discrete function spaces. It assumes the mapper to be a singleton and then compares the addresses of the two mappers.

Note that this method can be specialized by implementing another version that uses the exact traits of the discrete function space.

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

dune/fem/space/padaptivespace/generic.hh

Public Types

Public Member Functions

Static Public Attributes

Related Functions

Detailed Description

Constructor & Destructor Documentation

◆ GenericDiscreteFunctionSpace()

Member Function Documentation

◆ adapt()

◆ auxiliarySize()

◆ basisFunctionSet() [1/2]

◆ basisFunctionSet() [2/2]

◆ begin()

◆ blockMapper()

◆ communicate() [1/2]

◆ communicate() [2/2]

◆ communicationDirection()

◆ communicationInterface()

◆ communicator()

◆ compiledLocalKey() [1/2]

◆ compiledLocalKey() [2/2]

◆ continuous() [1/2]

◆ continuous() [2/2]

◆ createDataHandle()

◆ end()

◆ forEach()

◆ geomTypes()

◆ getMark()

◆ grid() [1/2]

◆ grid() [2/2]

◆ gridPart() [1/2]

◆ gridPart() [2/2]

◆ indexSet()

◆ key()

◆ mark()

◆ multipleBasisFunctionSets()

◆ multipleGeometryTypes()

◆ order() [1/3]

◆ order() [2/3]

◆ order() [3/3]

◆ primarySize()

◆ sequence()

◆ shapeFunctionSet() [1/2]

◆ shapeFunctionSet() [2/2]

◆ size()

◆ type()

Friends And Related Function Documentation

◆ operator==()