dune-pdelab 2.7-git
Loading...
Searching...
No Matches
Classes | Public Types | Public Member Functions | Public Attributes | Protected Member Functions | List of all members
Dune::PDELab::GridFunctionSpace< GV, FEM, CE, B, O > Class Template Reference

A grid function space. More...

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

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

Classes

struct  ConstraintsContainer
 extract type for storing constraints More...
 

Public Types

typedef GridFunctionSpaceTraits< GV, FEM, CE, B, O > Traits
 export Traits class
 
typedef GV::Traits::template Codim< 0 >::Entity Element
 
typedef GV::Traits::template Codim< 0 >::Iterator ElementIterator
 
typedef O 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
 
 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
 
 GridFunctionSpace (const typename Traits::GridView &gridview, const FEM &fem, const B &backend=B(), const OrderingTag &ordering_tag=OrderingTag())
 constructor
 
 GridFunctionSpace (const typename Traits::GridView &gridview, const std::shared_ptr< const FEM > &fem, const B &backend=B(), const OrderingTag &ordering_tag=OrderingTag())
 constructor
 
 GridFunctionSpace (const typename Traits::EntitySet &entitySet, const FEM &fem, const CE &ce, const B &backend=B(), const OrderingTag &ordering_tag=OrderingTag())
 constructor
 
 GridFunctionSpace (const typename Traits::EntitySet &entitySet, const std::shared_ptr< const FEM > &fem, const std::shared_ptr< const CE > &ce, const B &backend=B(), const OrderingTag &ordering_tag=OrderingTag())
 constructor
 
 GridFunctionSpace (const typename Traits::EntitySet &entitySet, const FEM &fem, const B &backend=B(), const OrderingTag &ordering_tag=OrderingTag())
 constructor
 
 GridFunctionSpace (const typename Traits::EntitySet &entitySet, const std::shared_ptr< const FEM > &fem, const B &backend=B(), const OrderingTag &ordering_tag=OrderingTag())
 constructor
 
const Traits::GridViewgridView () const
 get grid view
 
const Traits::EntitySetentitySet () const
 get EntitySet
 
const FEM & finiteElementMap () const
 get finite element map
 
std::shared_ptr< const FEM > finiteElementMapStorage () const
 get finite element map
 
const Traits::ConstraintsType & constraints () const
 return constraints engine
 
std::shared_ptr< const CE > constraintsStorage () const
 return storage of constraints engine
 
const Orderingordering () const
 Direct access to the DOF ordering.
 
Orderingordering ()
 Direct access to the DOF ordering.
 
std::shared_ptr< const OrderingorderingStorage () const
 Direct access to the storage of the DOF ordering.
 
std::shared_ptr< OrderingorderingStorage ()
 Direct access to the storage of the DOF ordering.
 
Traits::SizeType size () const
 
Traits::SizeType blockCount () const
 
Traits::SizeType globalSize () const
 
Traits::SizeType maxLocalSize () const
 get max dimension of shape function space
 
void update (bool force=false)
 Update the indexing information of the GridFunctionSpace.
 
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.
 
void setDataSetType (Output::DataSetType dataSetType)
 Set the data set type of this function.
 
bool dataHandleContains (int codim) const
 returns true if data for this codim should be communicated
 
bool dataHandleFixedSize (int codim) const
 returns true if size per entity of given dim and codim is a constant
 
constexpr bool sendLeafSizes () const
 Returns true if the sizes of the leaf orderings in this tree should be sent as part of the communcation.
 
template<typename Entity >
size_type dataHandleSize (const Entity &e) const
 
template<typename V , typename EntityIndex >
void setup_dof_indices (V &v, size_type n, const EntityIndex &ei, std::integral_constant< bool, true >) const
 
template<typename V , typename EntityIndex >
void setup_dof_indices (V &v, size_type n, const EntityIndex &ei, std::integral_constant< bool, false >) const
 
template<typename V >
V::iterator dof_indices_begin (V &v, std::integral_constant< bool, true >) const
 
template<typename V >
DummyDOFIndexIterator dof_indices_begin (V &v, std::integral_constant< bool, false >) const
 
template<typename Entity , typename ContainerIndex , typename DOFIndex , typename OffsetIterator , bool map_dof_indices>
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
 

Public Attributes

DUNE_DEPRECATED typedef O SizeTag
 

Protected Member Functions

template<typename Ordering >
void update (Ordering &ordering) const
 
const GFS & gfs () const
 

Detailed Description

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

A grid function space.

Template Parameters
GVType implementing GridView
FEMType implementing FiniteElementMapInterface
CEType for constraints assembler
BBackend type
OOrdering tag
Examples
recipe-blocking.cc, recipe-communication.cc, recipe-geometry-grid.cc, recipe-linear-system-assembly.cc, recipe-linear-system-solution-istl.cc, recipe-linear-system-solution-pdelab.cc, and recipe-operator-splitting.cc.

Member Typedef Documentation

◆ size_type

template<typename GFS >
typedef std::size_t Dune::PDELab::DataHandleProvider< GFS >::size_type
inherited

Member Function Documentation

◆ dataHandleContains()

template<typename GFS >
bool Dune::PDELab::DataHandleProvider< GFS >::dataHandleContains ( int  codim) const
inlineinherited

returns true if data for this codim should be communicated

◆ dataHandleFixedSize()

template<typename GFS >
bool Dune::PDELab::DataHandleProvider< GFS >::dataHandleFixedSize ( int  codim) const
inlineinherited

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

◆ dataHandleIndices()

template<typename GFS >
template<typename Entity , typename ContainerIndex , typename DOFIndex , typename OffsetIterator , bool map_dof_indices>
void Dune::PDELab::DataHandleProvider< GFS >::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()

template<typename GFS >
template<typename Entity >
size_type Dune::PDELab::DataHandleProvider< GFS >::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]

template<typename GFS >
template<typename V >
DummyDOFIndexIterator Dune::PDELab::DataHandleProvider< GFS >::dof_indices_begin ( V &  v,
std::integral_constant< bool, false >   
) const
inlineinherited

◆ dof_indices_begin() [2/2]

template<typename GFS >
template<typename V >
V::iterator Dune::PDELab::DataHandleProvider< GFS >::dof_indices_begin ( V &  v,
std::integral_constant< bool, true >   
) const
inlineinherited

◆ gfs()

template<typename GFS >
const GFS & Dune::PDELab::DataHandleProvider< GFS >::gfs ( ) const
inlineprotectedinherited

◆ sendLeafSizes()

template<typename GFS >
constexpr bool Dune::PDELab::DataHandleProvider< GFS >::sendLeafSizes ( ) const
inlineconstexprinherited

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]

template<typename GFS >
template<typename V , typename EntityIndex >
void Dune::PDELab::DataHandleProvider< GFS >::setup_dof_indices ( V &  v,
size_type  n,
const EntityIndex &  ei,
std::integral_constant< bool, false >   
) const
inlineinherited

◆ setup_dof_indices() [2/2]

template<typename GFS >
template<typename V , typename EntityIndex >
void Dune::PDELab::DataHandleProvider< GFS >::setup_dof_indices ( V &  v,
size_type  n,
const EntityIndex &  ei,
std::integral_constant< bool, true >   
) const
inlineinherited

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