Reference documentation for deal.II version 8.4.1
Todo List
Class Algorithms::OperatorBase
Update this documentation and the one of Operator
Class AnyData
GK: Deprecate access to AnyData by index and change to a map.
Class BlockInfo
Extend the functions local() and renumber() to the concept to hpDoFHandler.
Class BlockSparsityPatternBase< SparsityPatternType >
Handle optimization of diagonal elements of the underlying SparsityPattern correctly.
Class CellId
Does it make sense to implement a more efficient representation (internally and/or as a string)? If yes, something like a 64bit int as in p4est would be a good option.
Member DataOut< dim, DoFHandlerType >::build_patches (const Mapping< DoFHandlerType::dimension, DoFHandlerType::space_dimension > &mapping, const unsigned int n_subdivisions=0, const CurvedCellRegion curved_region=curved_boundary)
The mapping argument should be replaced by a hp::MappingCollection in case of a hp::DoFHandler.
Class DataOutFaces< dim, DoFHandlerType >
Reimplement this whole class using actual FEFaceValues and MeshWorker.
Member DataOutFaces< dim, DoFHandlerType >::build_patches (const Mapping< dimension > &mapping, const unsigned int n_subdivisions=0)
The mapping argument should be replaced by a hp::MappingCollection in case of a hp::DoFHandler.
Member DoFTools::DeclException0 (ExcFiniteElementsDontMatch)
Write description
Member DoFTools::DeclException0 (ExcGridNotCoarser)
Write description
Member DoFTools::DeclException0 (ExcGridsDontMatch)
Write description
Member DoFTools::DeclException0 (ExcInvalidBoundaryIndicator)
Write description
Class FE_ABF< dim >
Even if this element is implemented for two and three space dimensions, the definition of the node values relies on consistently oriented faces in 3D. Therefore, care should be taken on complicated meshes.
Class FE_BDM< dim >

The 3D version exhibits some numerical instabilities, in particular for higher order

Restriction matrices are missing.

Class FE_Nedelec< dim >
Even if this element is implemented for two and three space dimensions, the definition of the node values relies on consistently oriented faces in 3D. Therefore, care should be taken on complicated meshes.
Class FE_Poly< PolynomialType, dim, spacedim >
Since nearly all functions for spacedim != dim are specialized, this class needs cleaning up.
Class FE_RaviartThomas< dim >
Even if this element is implemented for two and three space dimensions, the definition of the node values relies on consistently oriented faces in 3D. Therefore, care should be taken on complicated meshes.
Class FE_RaviartThomasNodal< dim >

The current implementation is for Cartesian meshes only. You must use MappingCartesian.

Even if this element is implemented for two and three space dimensions, the definition of the node values relies on consistently oriented faces in 3D. Therefore, care should be taken on complicated meshes.

Class FE_TraceQ< dim, spacedim >
Polynomials::LagrangeEquidistant should be and will be replaced by Polynomials::LagrangeGaussLobatto as soon as such a polynomial set exists.
Member FESubfaceValues< dim, spacedim >::DeclException0 (ExcReinitCalledWithBoundaryFace)
Document this
Member FESubfaceValues< dim, spacedim >::DeclException0 (ExcFaceHasNoSubfaces)
Document this
Member FEValuesBase< dim, spacedim >::DeclException0 (ExcCannotInitializeField)
Document this
Member FEValuesBase< dim, spacedim >::DeclException0 (ExcFEDontMatch)
Document this
Member FEValuesBase< dim, spacedim >::DeclException0 (ExcFENotPrimitive)
Document this
Member FEValuesBase< dim, spacedim >::DeclException0 (ExcInvalidUpdateFlag)
Document this
Member FEValuesBase< dim, spacedim >::DeclException1 (ExcShapeFunctionNotPrimitive, int,<< "The shape function with index "<< arg1<< " is not primitive, i.e. it is vector-valued and "<< "has more than one non-zero vector component. This "<< "function cannot be called for these shape functions. "<< "Maybe you want to use the same function with the "<< "_component suffix?")
Document this
Member internal::Triangulation::TriaObjects< G >::next_free_pair_object (const ::Triangulation< dim, spacedim > &tria)
This function is not instantiated for the codim-one case
Member internal::Triangulation::TriaObjects< G >::next_free_single_object (const ::Triangulation< dim, spacedim > &tria)
This function is not instantiated for the codim-one case
Member LocalIntegrators::Divergence::cell_residual (Vector< number > &result, const FEValuesBase< dim > &fetest, const VectorSlice< const std::vector< std::vector< double > > > &input, const double factor=1.)
Verify: The function cell_matrix() is the Frechet derivative of this function with respect to the test functions.
Member LocalIntegrators::Divergence::gradient_residual (Vector< number > &result, const FEValuesBase< dim > &fetest, const std::vector< double > &input, const double factor=1.)
Verify: The function gradient_matrix() is the Frechet derivative of this function with respect to the test functions.
Class Mapping< dim, spacedim >
Document what happens in the codimension-1 case.
Member Mapping< dim, spacedim >::transform (const ArrayView< const Tensor< 2, dim > > &input, const MappingType type, const typename Mapping< dim, spacedim >::InternalDataBase &internal, const ArrayView< Tensor< 2, spacedim > > &output) const =0
The formulas for mapping_covariant_gradient, mapping_contravariant_gradient and mapping_piola_gradient are only true as stated for linear mappings. If, for example, the mapping is bilinear (or has a higher order polynomial degree) then there is a missing term associated with the derivative of \(J\).
Class MatrixBlock< MatrixType >
Example for the product preconditioner of the pressure Schur complement.
Member MatrixBlock< MatrixType >::add (const std::vector< size_type > &indices, const FullMatrix< number > &full_matrix, const bool elide_zero_values=true)
elide_zero_values is currently ignored.
Member MatrixBlock< MatrixType >::add (const size_type row_index, const std::vector< size_type > &col_indices, const std::vector< number > &values, const bool elide_zero_values=true)
elide_zero_values is currently ignored.
Member MatrixBlock< MatrixType >::add (const std::vector< size_type > &row_indices, const std::vector< size_type > &col_indices, const FullMatrix< number > &full_matrix, const bool elide_zero_values=true)
elide_zero_values is currently ignored.
Member MatrixCreator::create_boundary_mass_matrix (const Mapping< dim, spacedim > &mapping, const DoFHandler< dim, spacedim > &dof, const Quadrature< dim-1 > &q, SparseMatrix< double > &matrix, const typename FunctionMap< spacedim >::type &boundary_functions, Vector< double > &rhs_vector, std::vector< types::global_dof_index > &dof_to_boundary_mapping, const Function< spacedim > *const weight=0, std::vector< unsigned int > component_mapping=std::vector< unsigned int >())
This function does not work for finite elements with cell-dependent shape functions.
Class MeshWorker::Assembler::MGMatrixSimple< MatrixType >
The matrix structures needed for assembling level matrices with local refinement and continuous elements are missing.
Class MeshWorker::Assembler::ResidualLocalBlocksToGlobalBlocks< VectorType >
Comprehensive model currently not implemented.
Class MeshWorker::DoFInfoBox< dim, DOFINFO >
Currently, we are storing an object for the cells and two for each face. We could gather all face data pertaining to the cell itself in one object, saving a bit of memory and a few operations, but sacrificing some cleanliness.
Class MGTransferBase< VectorType >
update the following documentation, since it does not reflect the latest changes in structure.
Class PathSearch
Add support for environment variables like in kpathsea.
Class PolynomialsAdini
This polynomial space is implemented in 2D only.
Member Threads::this_thread_id ()
As of now, none of our systems seems to support gettid, so that part of the code is untested yet.
Member VectorTools::interpolate (const Mapping< dim, spacedim > &mapping, const DoFHandlerType< dim, spacedim > &dof, const Function< spacedim, double > &function, VectorType &vec)
The mapping argument should be replaced by a hp::MappingCollection in case of a hp::DoFHandler.