dune-pdelab  2.5-dev
Classes | Public Types | Public Member Functions | Protected Member Functions | List of all members
Dune::PDELab::GridFunctionSpace< GV, FEM, CE, B, P > Class Template Reference

A grid function space. More...

#include <dune/pdelab/gridfunctionspace/gridfunctionspace.hh>

Inheritance diagram for Dune::PDELab::GridFunctionSpace< GV, FEM, CE, B, P >:
Inheritance graph

Classes

struct  ConstraintsContainer
 extract type for storing constraints More...
 

Public Types

typedef GridFunctionSpaceTraits< GV, FEM, CE, B, P > Traits
 export Traits class More...
 
typedef GV::Traits::template Codim< 0 >::Entity Element
 
typedef GV::Traits::template Codim< 0 >::Iterator ElementIterator
 
typedef P SizeTag
 
typedef P OrderingTag
 
typedef LeafGridFunctionSpaceTag ImplementationTag
 
typedef ordering_transformation::Type Ordering
 
typedef std::size_t size_type
 

Public Member Functions

 GridFunctionSpace (const typename Traits::GridView &gridview, const FEM &fem, const CE &ce, const B &backend=B(), const OrderingTag &ordering_tag=OrderingTag())
 constructor More...
 
 GridFunctionSpace (const typename Traits::GridView &gridview, const std::shared_ptr< const FEM > &fem, const std::shared_ptr< const CE > &ce, const B &backend=B(), const OrderingTag &ordering_tag=OrderingTag())
 constructor More...
 
 GridFunctionSpace (const typename Traits::GridView &gridview, const FEM &fem, const B &backend=B(), const OrderingTag &ordering_tag=OrderingTag())
 constructor More...
 
 GridFunctionSpace (const typename Traits::GridView &gridview, const std::shared_ptr< const FEM > &fem, const B &backend=B(), const OrderingTag &ordering_tag=OrderingTag())
 constructor More...
 
const Traits::GridViewgridView () const
 get grid view More...
 
const Traits::EntitySetentitySet () const
 get EntitySet More...
 
const FEM & finiteElementMap () const
 get finite element map More...
 
std::shared_ptr< const FEM > finiteElementMapStorage () const
 get finite element map More...
 
const Traits::ConstraintsTypeconstraints () const
 return constraints engine More...
 
std::shared_ptr< const CE > constraintsStorage () const
 return storage of constraints engine More...
 
const Orderingordering () const
 Direct access to the DOF ordering. More...
 
Orderingordering ()
 Direct access to the DOF ordering. More...
 
std::shared_ptr< const OrderingorderingStorage () const
 Direct access to the storage of the DOF ordering. More...
 
std::shared_ptr< OrderingorderingStorage ()
 Direct access to the storage of the DOF ordering. More...
 
Traits::SizeType size () const
 
Traits::SizeType blockCount () const
 
Traits::SizeType globalSize () const
 
Traits::SizeType maxLocalSize () const
 get max dimension of shape function space More...
 
void update (bool force=false)
 Update the indexing information of the GridFunctionSpace. More...
 
const std::string & name () const
 
void name (const std::string &name)
 
Traits::Backendbackend ()
 
const Traits::Backendbackend () const
 
Traits::OrderingTagorderingTag ()
 
const Traits::OrderingTagorderingTag () const
 
bool isRootSpace () const
 
Output::DataSetType dataSetType () const
 Return the data set type of this function. More...
 
void setDataSetType (Output::DataSetType dataSetType)
 Set the data set type of this function. More...
 
bool dataHandleContains (int codim) const
 returns true if data for this codim should be communicated More...
 
bool dataHandleFixedSize (int codim) const
 returns true if size per entity of given dim and codim is a constant More...
 
constexpr bool sendLeafSizes () const
 Returns true if the sizes of the leaf orderings in this tree should be sent as part of the communcation. More...
 
size_type dataHandleSize (const Entity &e) const
 
void setup_dof_indices (V &v, size_type n, const EntityIndex &ei, std::integral_constant< bool, true >) const
 
void setup_dof_indices (V &v, size_type n, const EntityIndex &ei, std::integral_constant< bool, false >) const
 
V::iterator dof_indices_begin (V &v, std::integral_constant< bool, true >) const
 
DummyDOFIndexIterator dof_indices_begin (V &v, std::integral_constant< bool, false >) const
 
void dataHandleIndices (const Entity &e, std::vector< ContainerIndex > &container_indices, std::vector< DOFIndex > &dof_indices, OffsetIterator oit, std::integral_constant< bool, map_dof_indices > map_dof_indices_value) const
 return vector of global indices associated with the given entity More...
 

Protected Member Functions

void update (Ordering &ordering) const
 
const GridFunctionSpace< GV, FEM, CE, B, P > & gfs () const
 

Detailed Description

template<typename GV, typename FEM, typename CE = NoConstraints, typename B = ISTL::VectorBackend<>, typename P = DefaultLeafOrderingTag>
class Dune::PDELab::GridFunctionSpace< GV, FEM, CE, B, P >

A grid function space.

Template Parameters
GVType implementing GridView
FEMType implementing FiniteElementMapInterface
CEType for constraints assembler
BBackend type
PParameter type. Possible types are GridFunctionGeneralMapper (arbitrary number of unknowns per entity) or GridFunctionRestrictedMapper (fixed number of unknowns per entity) or GridFunctionStaticSize (number of unknowns per entity, known at compile-time)

Member Typedef Documentation

◆ size_type

typedef std::size_t Dune::PDELab::DataHandleProvider< GridFunctionSpace< GV, FEM, CE, B, P > >::size_type
inherited

Member Function Documentation

◆ backend() [1/2]

Traits::Backend& Dune::PDELab::GridFunctionSpaceBase< GridFunctionSpace< GV, FEM, CE, B, P > , GridFunctionSpaceTraits< GV, FEM, CE, B, P > >::backend ( )
inlineinherited

◆ backend() [2/2]

const Traits::Backend& Dune::PDELab::GridFunctionSpaceBase< GridFunctionSpace< GV, FEM, CE, B, P > , GridFunctionSpaceTraits< GV, FEM, CE, B, P > >::backend ( ) const
inlineinherited

◆ blockCount()

Traits::SizeType Dune::PDELab::GridFunctionSpaceBase< GridFunctionSpace< GV, FEM, CE, B, P > , GridFunctionSpaceTraits< GV, FEM, CE, B, P > >::blockCount ( ) const
inlineinherited

◆ dataHandleContains()

bool Dune::PDELab::DataHandleProvider< GridFunctionSpace< GV, FEM, CE, B, P > >::dataHandleContains ( int  codim) const
inlineinherited

returns true if data for this codim should be communicated

◆ dataHandleFixedSize()

bool Dune::PDELab::DataHandleProvider< GridFunctionSpace< GV, FEM, CE, B, P > >::dataHandleFixedSize ( int  codim) const
inlineinherited

returns true if size per entity of given dim and codim is a constant

◆ dataHandleIndices()

void Dune::PDELab::DataHandleProvider< GridFunctionSpace< GV, FEM, CE, B, P > >::dataHandleIndices ( const Entity &  e,
std::vector< ContainerIndex > &  container_indices,
std::vector< DOFIndex > &  dof_indices,
OffsetIterator  oit,
std::integral_constant< bool, map_dof_indices >  map_dof_indices_value 
) const
inlineinherited

return vector of global indices associated with the given entity

◆ dataHandleSize()

size_type Dune::PDELab::DataHandleProvider< GridFunctionSpace< GV, FEM, CE, B, P > >::dataHandleSize ( const Entity &  e) const
inlineinherited

how many objects of type DataType have to be sent for a given entity

Note: Only the sender side needs to know this size.

◆ dataSetType()

Output::DataSetType Dune::PDELab::GridFunctionOutputParameters::dataSetType ( ) const
inlineinherited

Return the data set type of this function.

◆ dof_indices_begin() [1/2]

V::iterator Dune::PDELab::DataHandleProvider< GridFunctionSpace< GV, FEM, CE, B, P > >::dof_indices_begin ( V &  v,
std::integral_constant< bool, true >   
) const
inlineinherited

◆ dof_indices_begin() [2/2]

DummyDOFIndexIterator Dune::PDELab::DataHandleProvider< GridFunctionSpace< GV, FEM, CE, B, P > >::dof_indices_begin ( V &  v,
std::integral_constant< bool, false >   
) const
inlineinherited

◆ gfs()

const GridFunctionSpace< GV, FEM, CE, B, P > & Dune::PDELab::DataHandleProvider< GridFunctionSpace< GV, FEM, CE, B, P > >::gfs ( ) const
inlineprotectedinherited

◆ globalSize()

Traits::SizeType Dune::PDELab::GridFunctionSpaceBase< GridFunctionSpace< GV, FEM, CE, B, P > , GridFunctionSpaceTraits< GV, FEM, CE, B, P > >::globalSize ( ) const
inlineinherited

◆ isRootSpace()

bool Dune::PDELab::GridFunctionSpaceBase< GridFunctionSpace< GV, FEM, CE, B, P > , GridFunctionSpaceTraits< GV, FEM, CE, B, P > >::isRootSpace ( ) const
inlineinherited

◆ maxLocalSize()

Traits::SizeType Dune::PDELab::GridFunctionSpaceBase< GridFunctionSpace< GV, FEM, CE, B, P > , GridFunctionSpaceTraits< GV, FEM, CE, B, P > >::maxLocalSize ( ) const
inlineinherited

get max dimension of shape function space

◆ name() [1/2]

const std::string& Dune::PDELab::GridFunctionSpaceBase< GridFunctionSpace< GV, FEM, CE, B, P > , GridFunctionSpaceTraits< GV, FEM, CE, B, P > >::name ( ) const
inlineinherited

◆ name() [2/2]

void Dune::PDELab::GridFunctionSpaceBase< GridFunctionSpace< GV, FEM, CE, B, P > , GridFunctionSpaceTraits< GV, FEM, CE, B, P > >::name ( const std::string &  name)
inlineinherited

◆ orderingTag() [1/2]

Traits::OrderingTag& Dune::PDELab::GridFunctionSpaceBase< GridFunctionSpace< GV, FEM, CE, B, P > , GridFunctionSpaceTraits< GV, FEM, CE, B, P > >::orderingTag ( )
inlineinherited

◆ orderingTag() [2/2]

const Traits::OrderingTag& Dune::PDELab::GridFunctionSpaceBase< GridFunctionSpace< GV, FEM, CE, B, P > , GridFunctionSpaceTraits< GV, FEM, CE, B, P > >::orderingTag ( ) const
inlineinherited

◆ sendLeafSizes()

constexpr bool Dune::PDELab::DataHandleProvider< GridFunctionSpace< GV, FEM, CE, B, P > >::sendLeafSizes ( ) const
inlineinherited

Returns true if the sizes of the leaf orderings in this tree should be sent as part of the communcation.

The MultiDomain extensions require knowledge about the size of the individual orderings, which might belong to separate subdomains. Otherwise it is possible to have size mismatches for entities with codim > 0 if there are protruding edges in the parallel mesh partitioning.

By default, this method will always return false. It must be overridden for cases where the data actually needs to be sent.

This flag also modifies the behavior of the generic data handles, which will automatically send, receive and process the additional information. Note that if sendLeafSizes() returns true, the underlying DataHandleIF of the grid will always use the data type char to be able to send different types of data, which will automatically be marshalled to / from a byte stream.

◆ setDataSetType()

void Dune::PDELab::GridFunctionOutputParameters::setDataSetType ( Output::DataSetType  dataSetType)
inlineinherited

Set the data set type of this function.

◆ setup_dof_indices() [1/2]

void Dune::PDELab::DataHandleProvider< GridFunctionSpace< GV, FEM, CE, B, P > >::setup_dof_indices ( V &  v,
size_type  n,
const EntityIndex &  ei,
std::integral_constant< bool, true >   
) const
inlineinherited

◆ setup_dof_indices() [2/2]

void Dune::PDELab::DataHandleProvider< GridFunctionSpace< GV, FEM, CE, B, P > >::setup_dof_indices ( V &  v,
size_type  n,
const EntityIndex &  ei,
std::integral_constant< bool, false >   
) const
inlineinherited

◆ size()

Traits::SizeType Dune::PDELab::GridFunctionSpaceBase< GridFunctionSpace< GV, FEM, CE, B, P > , GridFunctionSpaceTraits< GV, FEM, CE, B, P > >::size ( ) const
inlineinherited

◆ update() [1/2]

void Dune::PDELab::GridFunctionSpaceBase< GridFunctionSpace< GV, FEM, CE, B, P > , GridFunctionSpaceTraits< GV, FEM, CE, B, P > >::update ( bool  force = false)
inlineinherited

Update the indexing information of the GridFunctionSpace.

\ param force Set to true if the underlying grid has changed (e.g. due to adaptivity) to force an update of the embedded EntitySet.

◆ update() [2/2]

void Dune::PDELab::GridFunctionSpaceBase< GridFunctionSpace< GV, FEM, CE, B, P > , GridFunctionSpaceTraits< GV, FEM, CE, B, P > >::update ( Ordering &  ordering) const
inlineprotectedinherited

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