*
*
* @ingroup LAC
- * @ingroup MATRICES
*/
* <code>RefinementPossibilities@<1@></code>,
* <code>RefinementPossibilities@<2@></code>, and
* <code>RefinementPossibilities@<3@></code>.
- *
- * @ingroup aniso
*/
template <int dim>
struct RefinementPossibilities
*
* This specialization is used for <code>dim=1</code>, where it offers
* refinement in x-direction.
- *
- * @ingroup aniso
*/
template <>
struct RefinementPossibilities<1>
* This specialization is used for <code>dim=2</code>, where it offers
* refinement in x- and y-direction separately, as well as isotropic
* refinement in both directions at the same time.
- *
- * @ingroup aniso
*/
template <>
struct RefinementPossibilities<2>
* This specialization is used for <code>dim=3</code>, where it offers
* refinement in x-, y- and z-direction separately, as well as combinations of
* these and isotropic refinement in all directions at the same time.
- *
- * @ingroup aniso
*/
template <>
struct RefinementPossibilities<3>
* <code>dim=2</code>, etc.). Possible values of this class are the ones
* listed in the enumeration declared within the base class; see there for
* more information.
- *
- * @ingroup aniso
*/
template <int dim>
class RefinementCase : public RefinementPossibilities<dim>
* <code>SubfacePossibilities@<1@></code>,
* <code>SubfacePossibilities@<2@></code> and
* <code>SubfacePossibilities@<3@></code>.
- *
- * @ingroup aniso
*/
template <int dim>
struct SubfacePossibilities
* space dimension @p dim) might be subdivided into subfaces.
*
* For <code>dim=0</code> we provide a dummy implementation only.
- *
- * @ingroup aniso
*/
template <>
struct SubfacePossibilities<0>
*
* For <code>dim=1</code> there are no faces. Thereby, there are no subface
* possibilities.
- *
- * @ingroup aniso
*/
template <>
struct SubfacePossibilities<1>
* This specialization is used for <code>dim=2</code>, where it offers the
* following possibilities: a face (line) being refined
* (<code>case_x</code>) or not refined (<code>case_no</code>).
- *
- * @ingroup aniso
*/
template <>
struct SubfacePossibilities<2>
* *---*---*
*
* @endcode
- *
- * @ingroup aniso
*/
template <>
struct SubfacePossibilities<3>
/**
* A class that provides all possible cases a face (in the current space
* dimension @p dim) might be subdivided into subfaces.
- *
- * @ingroup aniso
*/
template <int dim>
class SubfaceCase : public SubfacePossibilities<dim>
* This information should always replace hard-coded numbers of vertices,
* neighbors and so on, since it can be used dimension independently.
*
- * @ingroup grid geomprimitives aniso
+ * @ingroup grid geomprimitives
*/
template <>
struct GeometryInfo<0>
* @ref Instantiations
* in the manual).
*
- * @ingroup grid geomprimitives aniso
+ * @ingroup grid geomprimitives
*/
template <int dim>
struct GeometryInfo
* an MPI communicator, a list of targets, and function objects that
* encode and decode the messages to be sent, but no functions for
* encoding a reply, or processing a reply.
- *
- * @ingroup MPI
*/
namespace ConsensusAlgorithms
{
* the calls that add subtasks. Otherwise, there might be a deadlock. In
* other words, a Task object should never passed on to another task for
* calling the join() method.
- *
- * @ingroup tasks
*/
template <typename RT = void>
class TaskGroup
{
/**
* A namespace for the fully distributed triangulation.
- *
- * @ingroup parallel
*/
namespace fullydistributed
{
* will represent the number of different indicators (which is greater or
* equal one).
*
- * @ingroup boundary
- *
* @see
* @ref GlossBoundaryIndicator "Glossary entry on boundary indicators"
*
/**
* Namespace Airfoil contains classes and functions in order to create a
* C-type mesh for the (flow) field around Joukowski or NACA airfoils.
- *
- * @ingroup GridGenerator
*/
namespace Airfoil
{
* @ref GlossReferenceCell "reference cell"
* glossary entry.
*
- * @ingroup grid geomprimitives aniso reordering
+ * @ingroup grid geomprimitives reordering
*/
class ReferenceCell
{
* object, you should be well aware that you might involuntarily alter the
* data stored in the triangulation.
*
- * @ingroup grid aniso
+ * @ingroup grid
*
* @dealiiConceptRequires{(concepts::is_valid_dim_spacedim<dim, spacedim>)}
*/
* will represent the number of different indicators (which is greater or
* equal one).
*
- * @ingroup boundary
- *
* @see
* @ref GlossBoundaryIndicator "Glossary entry on boundary indicators"
*/
* the value you are trying to set makes sense under the current
* circumstances.
*
- * @ingroup boundary
- *
* @see
* @ref GlossBoundaryIndicator "Glossary entry on boundary indicators"
*/
* the result of not using the correct function in the results section of
* step-49.
*
- * @ingroup boundary
- *
* @see
* @ref GlossBoundaryIndicator "Glossary entry on boundary indicators"
*/
* the value you are trying to set makes sense under the current
* circumstances.
*
- * @ingroup boundary
- *
* @see
* @ref GlossBoundaryIndicator "Glossary entry on boundary indicators"
*/
* vertex, there are no lower-dimensional object and this function is
* equivalent to calling set_boundary_id() with the same argument.
*
- * @ingroup boundary
- *
* @see
* @ref GlossBoundaryIndicator "Glossary entry on boundary indicators"
*/
/**
* A namespace for TriangulationDescription::Description utility functions.
- *
- * @ingroup TriangulationDescription
*/
namespace Utilities
{
* available at <a Ginkgo
* href="https://ginkgo-project.github.io/ginkgo/doc/develop/"> documentation
* and manual pages</a>.
- *
- * @ingroup GinkgoWrappers
*/
template <typename ValueType, typename IndexType>
class SolverBase
/**
* An implementation of the solver interface using the Ginkgo CG solver.
- *
- * @ingroup GinkgoWrappers
*/
template <typename ValueType = double, typename IndexType = int32_t>
class SolverCG : public SolverBase<ValueType, IndexType>
/**
* An implementation of the solver interface using the Ginkgo Bicgstab solver.
- *
- * @ingroup GinkgoWrappers
*/
template <typename ValueType = double, typename IndexType = int32_t>
class SolverBicgstab : public SolverBase<ValueType, IndexType>
*
* CGS or the conjugate gradient square method is an iterative type Krylov
* subspace method which is suitable for general systems.
- *
- * @ingroup GinkgoWrappers
*/
template <typename ValueType = double, typename IndexType = int32_t>
class SolverCGS : public SolverBase<ValueType, IndexType>
* vectors spanning the Krylov subspace. This increases the computational cost
* of every Krylov solver iteration but allows for non-constant
* preconditioners.
- *
- * @ingroup GinkgoWrappers
*/
template <typename ValueType = double, typename IndexType = int32_t>
class SolverFCG : public SolverBase<ValueType, IndexType>
/**
* An implementation of the solver interface using the Ginkgo GMRES solver.
- *
- * @ingroup GinkgoWrappers
*/
template <typename ValueType = double, typename IndexType = int32_t>
class SolverGMRES : public SolverBase<ValueType, IndexType>
* Iterative refinement (IR) is an iterative method that uses another coarse
* method to approximate the error of the current solution via the current
* residual.
- *
- * @ingroup GinkgoWrappers
*/
template <typename ValueType = double, typename IndexType = int32_t>
class SolverIR : public SolverBase<ValueType, IndexType>
* collect_sizes() function, for much the same reason as is documented
* with the BlockSparsityPattern class.
*
- * @ingroup Matrix1 @see
- * @ref GlossBlockLA "Block (linear algebra)"
+ * @ingroup Matrix1
+ * @see @ref GlossBlockLA "Block (linear algebra)"
*/
class BlockSparseMatrix : public BlockMatrixBase<SparseMatrix>
{
* specify the sizes of the individual blocks, but also the number of
* elements of each of these blocks to be stored on the local process.
*
- * @ingroup Vectors @see
- * @ref GlossBlockLA "Block (linear algebra)"
+ * @ingroup Vectors
+ * @see @ref GlossBlockLA "Block (linear algebra)"
*/
class BlockVector : public BlockVectorBase<Vector>
{
* function, for much the same reason as is documented with the
* BlockSparsityPattern class.
*
- * @ingroup Matrix1 @see
- * @ref GlossBlockLA "Block (linear algebra)"
+ * @ingroup Matrix1
+ * @see @ref GlossBlockLA "Block (linear algebra)"
*/
class BlockSparseMatrix : public BlockMatrixBase<SparseMatrix>
{
* elements of each of these blocks to be stored on the local process.
*
* @ingroup Vectors
- * @ingroup TrilinosWrappers @see
- * @ref GlossBlockLA "Block (linear algebra)"
+ * @ingroup TrilinosWrappers
+ * @see @ref GlossBlockLA "Block (linear algebra)"
*/
class BlockVector : public dealii::BlockVectorBase<MPI::Vector>
{
* function, for much the same reason as is documented with the
* BlockSparsityPattern class.
*
- * @ingroup Matrix1 @see
- * @ref GlossBlockLA "Block (linear algebra)"
+ * @ingroup Matrix1
+ * @see @ref GlossBlockLA "Block (linear algebra)"
*/
template <typename Number, typename MemorySpace = dealii::MemorySpace::Host>
class BlockSparseMatrix
* elements of each of these blocks to be stored on the local process.
*
* @ingroup Vectors
- * @ingroup TrilinosWrappers @see
- * @ref GlossBlockLA "Block (linear algebra)"
+ * @ingroup TrilinosWrappers
+ * @see @ref GlossBlockLA "Block (linear algebra)"
*/
template <typename Number, typename MemorySpace = dealii::MemorySpace::Host>
class BlockVector : public dealii::BlockVectorBase<
* double.
*
* @ingroup CUDAWrappers
- * @ingroup Portable
*/
template <int dim,
int fe_degree,
* @note Only float and double are supported.
*
* @ingroup CUDAWrappers
- * @ingroup Portable
*/
template <int dim, typename Number = double>
class MatrixFree : public Subscriptor
* products are implemented.
*
* @ingroup CUDAWrappers
- * @ingroup Portable
*/
// TODO: for now only the general variant is implemented
enum EvaluatorVariant
* Generic evaluator framework.
*
* @ingroup CUDAWrappers
- * @ingroup Portable
*/
template <EvaluatorVariant variant,
int dim,
* of the basis functions.
*
* @ingroup CUDAWrappers
- * @ingroup Portable
*/
template <int dim, int fe_degree, int n_q_points_1d, typename Number>
struct EvaluatorTensorProduct<evaluate_general,
* The class does, in essence, for particles what ::DataOut does for
* finite element fields, using a similar interface. It is used in
* step-19, for example.
- *
- * @ingroup Particle
*/
template <int dim, int spacedim = dim>
class DataOut : public dealii::DataOutInterface<0, spacedim>
* 1.0, "blue" to 2.0, and "green" to 3.0. The conversion functions
* to translate between these two representations should then not be very
* difficult to write either.
- *
- * @ingroup Particle
*/
template <int dim, int spacedim = dim>
class Particle
* For examples on how to use this class to track particles, store properties
* on particles, and let the properties on the particles influence the
* finite-element solution see step-19, step-68, and step-70.
- *
- * @ingroup Particle
*/
template <int dim, int spacedim = dim>
class ParticleHandler : public Subscriptor
projects / dealii.git / commitdiff