class BlockIndices;
#endif
-/**
- * A collection of functions and classes for the mesh loops that are an
- * ubiquitous part of each finite element program.
- *
- * The workhorse of this namespace is the loop() function, which implements a
- * completely generic loop over all mesh cells.
- * The loop() function depends on certain objects handed to it as arguments.
- * These
- * objects are of two types, @p info objects like DoFInfo and IntegrationInfo and
- * function objects ("workers") that perform the local operations on cells,
- * faces, and boundaries.
- *
- * Worker objects usually do two different jobs: first, they compute the local
- * contribution of a cell or face to the global operation. Second, they
- * assemble this local contribution into the global result, whether a
- * functional, a form or a bilinear form. While the first job is particular to
- * the problem being solved, the second is generic and only depends on the
- * data structures. Therefore, base classes for workers assembling into global
- * data are provided in the namespace Assembler.
- *
- * <h3>Template argument types</h3>
- *
- * The functions loop() and cell_action() take some arguments which are
- * template parameters. Let us list the minimum requirements for these classes
- * here and describe their properties.
- *
- * <h4>ITERATOR</h4>
- *
- * Any object that has an <tt>operator++()</tt> and points to a
- * TriaAccessor or derived class.
- *
- * <h4>DOFINFO</h4>
- *
- * For an example implementation, refer to the class template DoFInfo. In
- * order to work with cell_action() and loop(), DOFINFO needs to follow the
- * following interface.
- * @code
- * class DOFINFO
- * {
- * private:
- * DOFINFO();
- * DOFINFO(const DOFINFO&);
- * DOFINFO& operator=(const DOFINFO&);
- *
- * public:
- * template <class CellIt>
- * void reinit(const CellIt& c);
- *
- * template <class CellIt, class FaceIt>
- * void reinit(const CellIt& c, const FaceIt& f, const unsigned int n);
- *
- * template <class CellIt, class FaceIt>
- * void reinit(const CellIt& c, const FaceIt& f, const unsigned int n,
- * const unsigned int s);
- *
- * friend template class DoFInfoBox<int dim, DOFINFO>;
- * };
- * @endcode
- *
- * The three private functions are called by DoFInfoBox and should not be
- * needed elsewhere. Obviously, they can be made public and then the friend
- * declaration at the end may be missing.
- *
- * Additionally, you will need at least one public constructor. Furthermore
- * DOFINFO is pretty useless yet: functions to interface with INTEGRATIONINFO
- * and ASSEMBLER are needed.
- *
- * DOFINFO objects are gathered in a DoFInfoBox. In those objects, we store
- * the results of local operations on each cell and its faces. Once all this
- * information has been gathered, an ASSEMBLER is used to assemble it into
- * global data.
- *
- * <h4>INFOBOX</h4>
- *
- * This type is exemplified in IntegrationInfoBox. It collects the input data
- * for actions on cells and faces in INFO objects (see below). It provides the
- * following interface to loop() and cell_action():
- *
- * @code
- * class INFOBOX
- * {
- * public:
- * template <int dim, class DOFINFO>
- * void post_cell(const DoFInfoBox<dim, DOFINFO>&);
- *
- * template <int dim, class DOFINFO>
- * void post_faces(const DoFInfoBox<dim, DOFINFO>&);
- *
- * INFO cell;
- * INFO boundary;
- * INFO face;
- * INFO subface;
- * INFO neighbor;
- * };
- * @endcode
- *
- * The main purpose of this class is gathering the five INFO objects, which
- * contain the temporary data used on each cell or face. The requirements on
- * these objects are listed below. Here, we only note that there need to be
- * these 5 objects with the names listed above.
- *
- * The two function templates are call back functions called in cell_action().
- * The first is called before the faces are worked on, the second after the
- * faces.
- *
- * <h4>INFO</h4>
- *
- * See IntegrationInfo for an example of these objects. They contain the
- * temporary data needed on each cell or face to compute the result. The
- * MeshWorker only uses the interface
- *
- * @code
- * class INFO
- * {
- * public:
- * void reinit(const DOFINFO& i);
- * };
- * @endcode
- *
- * @ingroup MeshWorker
- * @ingroup Integrators
- */
namespace MeshWorker
{
/**
+/**
+ * A collection of functions and classes for the mesh loops that are an
+ * ubiquitous part of each finite element program.
+ *
+ * The workhorse of this namespace is the loop() function, which implements a
+ * completely generic loop over all mesh cells.
+ * The loop() function depends on certain objects handed to it as arguments.
+ * These
+ * objects are of two types, @p info objects like DoFInfo and IntegrationInfo and
+ * function objects ("workers") that perform the local operations on cells,
+ * faces, and boundaries.
+ *
+ * Worker objects usually do two different jobs: first, they compute the local
+ * contribution of a cell or face to the global operation. Second, they
+ * assemble this local contribution into the global result, whether a
+ * functional, a form or a bilinear form. While the first job is particular to
+ * the problem being solved, the second is generic and only depends on the
+ * data structures. Therefore, base classes for workers assembling into global
+ * data are provided in the namespace Assembler.
+ *
+ * <h3>Template argument types</h3>
+ *
+ * The functions loop() and cell_action() take some arguments which are
+ * template parameters. Let us list the minimum requirements for these classes
+ * here and describe their properties.
+ *
+ * <h4>ITERATOR</h4>
+ *
+ * Any object that has an <tt>operator++()</tt> and points to a
+ * TriaAccessor or derived class.
+ *
+ * <h4>DOFINFO</h4>
+ *
+ * For an example implementation, refer to the class template DoFInfo. In
+ * order to work with cell_action() and loop(), DOFINFO needs to follow the
+ * following interface.
+ * @code
+ * class DOFINFO
+ * {
+ * private:
+ * DOFINFO();
+ * DOFINFO(const DOFINFO&);
+ * DOFINFO& operator=(const DOFINFO&);
+ *
+ * public:
+ * template <class CellIt>
+ * void reinit(const CellIt& c);
+ *
+ * template <class CellIt, class FaceIt>
+ * void reinit(const CellIt& c, const FaceIt& f, const unsigned int n);
+ *
+ * template <class CellIt, class FaceIt>
+ * void reinit(const CellIt& c, const FaceIt& f, const unsigned int n,
+ * const unsigned int s);
+ *
+ * friend template class DoFInfoBox<int dim, DOFINFO>;
+ * };
+ * @endcode
+ *
+ * The three private functions are called by DoFInfoBox and should not be
+ * needed elsewhere. Obviously, they can be made public and then the friend
+ * declaration at the end may be missing.
+ *
+ * Additionally, you will need at least one public constructor. Furthermore
+ * DOFINFO is pretty useless yet: functions to interface with INTEGRATIONINFO
+ * and ASSEMBLER are needed.
+ *
+ * DOFINFO objects are gathered in a DoFInfoBox. In those objects, we store
+ * the results of local operations on each cell and its faces. Once all this
+ * information has been gathered, an ASSEMBLER is used to assemble it into
+ * global data.
+ *
+ * <h4>INFOBOX</h4>
+ *
+ * This type is exemplified in IntegrationInfoBox. It collects the input data
+ * for actions on cells and faces in INFO objects (see below). It provides the
+ * following interface to loop() and cell_action():
+ *
+ * @code
+ * class INFOBOX
+ * {
+ * public:
+ * template <int dim, class DOFINFO>
+ * void post_cell(const DoFInfoBox<dim, DOFINFO>&);
+ *
+ * template <int dim, class DOFINFO>
+ * void post_faces(const DoFInfoBox<dim, DOFINFO>&);
+ *
+ * INFO cell;
+ * INFO boundary;
+ * INFO face;
+ * INFO subface;
+ * INFO neighbor;
+ * };
+ * @endcode
+ *
+ * The main purpose of this class is gathering the five INFO objects, which
+ * contain the temporary data used on each cell or face. The requirements on
+ * these objects are listed below. Here, we only note that there need to be
+ * these 5 objects with the names listed above.
+ *
+ * The two function templates are call back functions called in cell_action().
+ * The first is called before the faces are worked on, the second after the
+ * faces.
+ *
+ * <h4>INFO</h4>
+ *
+ * See IntegrationInfo for an example of these objects. They contain the
+ * temporary data needed on each cell or face to compute the result. The
+ * MeshWorker only uses the interface
+ *
+ * @code
+ * class INFO
+ * {
+ * public:
+ * void reinit(const DOFINFO& i);
+ * };
+ * @endcode
+ *
+ * @ingroup MeshWorker
+ * @ingroup Integrators
+ */
namespace MeshWorker
{
/**
projects / dealii.git / commitdiff