Doxygen API reference documentation for ideal.II
Public Member Functions | Protected Attributes | List of all members
idealii::spacetime::DoFHandler< dim > Class Template Reference

The spacetime dofhandler object. More...

#include <spacetime_dof_handler.hh>

Public Member Functions

 DoFHandler (spacetime::Triangulation< dim > *tria)
 Constructor based on spacetime::Triangulation. More...
 
 DoFHandler (spacetime::parallel::distributed::Triangulation< dim > *tria)
 Constructor based on parallel::distributed::spacetime::Triangulation. More...
 
void generate ()
 generate all slab::DofHandler objects. More...
 
unsigned int M ()
 The number of slabs. More...
 
slab::DoFHandlerIterator< dim > begin ()
 An iterator pointing to the first slab::DoFHandler. More...
 
slab::DoFHandlerIterator< dim > end ()
 An iterator pointing behind the last slab::DoFHandler. More...
 

Protected Attributes

Triangulation< dim > * _tria
 
spacetime::parallel::distributed::Triangulation< dim > * _par_dist_tria
 
std::list< slab::DoFHandler< dim > > _dof_handlers
 

Detailed Description

template<int dim>
class idealii::spacetime::DoFHandler< dim >

The spacetime dofhandler object.

In practice this is just a class around a list of shared pointers to slab::DoFHandler objects to simplify generation and time marching.

Constructor & Destructor Documentation

◆ DoFHandler() [1/2]

template<int dim>
idealii::spacetime::DoFHandler< dim >::DoFHandler ( spacetime::Triangulation< dim > *  tria)

Constructor based on spacetime::Triangulation.

Parameters
triaThe spacetime::Triangulation object to use in construction of the underlying handlers.

◆ DoFHandler() [2/2]

Constructor based on parallel::distributed::spacetime::Triangulation.

Parameters
triaThe parallel::distributed::spacetime::Triangulation object to use in construction of the underlying handlers.

Member Function Documentation

◆ begin()

template<int dim>
slab::DoFHandlerIterator<dim> idealii::spacetime::DoFHandler< dim >::begin ( )

An iterator pointing to the first slab::DoFHandler.

Returns
The result of the begin() call to the underlying list.

◆ end()

template<int dim>
slab::DoFHandlerIterator<dim> idealii::spacetime::DoFHandler< dim >::end ( )

An iterator pointing behind the last slab::DoFHandler.

Returns
The result of the end() call to the underlying list.

◆ generate()

template<int dim>
void idealii::spacetime::DoFHandler< dim >::generate ( )

generate all slab::DofHandler objects.

This function iterates over all slab::Triangulation objects in the underlying triangulation and constructs one slab::DoFHandler for each.

◆ M()

template<int dim>
unsigned int idealii::spacetime::DoFHandler< dim >::M ( )

The number of slabs.

Returns
The size of the underlying list.

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