* together).
*
* If you want to use boundary conditions with the matrices generated by the
- * functions of this class in addition to the ones in a possible constraint
- * matrix, you have to use a function like
+ * functions of this namespace in addition to the ones in a possible
+ * constraint matrix, you have to use a function like
* <tt>ProblemBase<>::apply_dirichlet_bc</tt> to matrix and right hand side.
*
*
* such matrices, for example in time dependent settings such as the main
* loop of step-26.
*
- * See the general doc of this class for more information.
+ * See the general documentation of this namespace for more information.
*/
template <int dim, typename number, int spacedim>
void create_mass_matrix (const Mapping<dim, spacedim> &mapping,
* such matrices, for example in time dependent settings such as the main
* loop of step-26.
*
- * See the general doc of this class for more information.
+ * See the general documentation of this namespace for more information.
*/
template <int dim, typename number, int spacedim>
void create_mass_matrix (const Mapping<dim, spacedim> &mapping,
* such matrices, for example in time dependent settings such as the main
* loop of step-26.
*
- * See the general doc of this class for more information.
+ * See the general documentation of this namespace for more information.
*/
template <int dim, int spacedim>
void create_laplace_matrix (const Mapping<dim, spacedim> &mapping,
* such matrices, for example in time dependent settings such as the main
* loop of step-26.
*
- * See the general doc of this class for more information.
+ * See the general documentation of this namespace for more information.
*/
template <int dim, int spacedim>
void create_laplace_matrix (const Mapping<dim, spacedim> &mapping,
* the given degree of freedom and thus eliminating all coupling between this
* degree of freedom and others. Now the respective column also consists only
* of zeroes, apart from the main diagonal entry. Alternatively, the functions
- * in this class take a boolean parameter that allows to omit this last step,
- * if symmetry of the resulting linear system is not required. Note that
+ * in this namespace take a boolean parameter that allows to omit this last
+ * step, if symmetry of the resulting linear system is not required. Note that
* usually even CG can cope with a non-symmetric linear system with this
* particular structure.
*
* where the action indicated by the default value of the last argument is
* actually not implemented; that argument has <code>true</code> as its
* default value to stay consistent with the other functions of same name in
- * this class.)
+ * this namespace.)
*
* This function is used in step-17 and step-18.
*/
* situation where the action indicated by the default value of the last
* argument is actually not implemented; that argument has <code>true</code>
* as its default value to stay consistent with the other functions of same
- * name in this class.)
+ * name in this namespace.)
*/
void
apply_boundary_values (const std::map<types::global_dof_index,double> &boundary_values,
* or if access to the sparse matrix is expensive (e.g. for block sparse
* matrices, or for PETSc or Trilinos matrices). However, it doesn't work as
* expected if there are also hanging nodes to be considered. More caveats
- * are listed in the general documentation of this class.
+ * are listed in the general documentation of this namespace.
*
* @dealiiVideoLecture{21.6,21.65}
*/
{
/**
* Denote which norm/integral is to be computed by the
- * integrate_difference() function of this class. The following
+ * integrate_difference() function of this namespace. The following
* possibilities are implemented:
*/
enum NormType
* The template argument <code>DH</code> may either be of type DoFHandler or
* hp::DoFHandler.
*
- * See the general documentation of this class for further information.
+ * See the general documentation of this namespace for further information.
*
* @todo The @p mapping argument should be replaced by a
* hp::MappingCollection in case of a hp::DoFHandler.
* continuous again.
*
* @note Instantiations for this template are provided for some vector types
- * (see the general documentation of the class), but only the same vector
- * for InVector and OutVector. Other combinations must be instantiated by
- * hand.
+ * (see the general documentation of the namespace), but only the same
+ * vector for InVector and OutVector. Other combinations must be
+ * instantiated by hand.
*/
template <int dim, class InVector, class OutVector, int spacedim>
void interpolate (const DoFHandler<dim,spacedim> &dof_1,
* sure that the given quadrature formula is also sufficient for the
* integration of the mass matrix.
*
- * See the general documentation of this class for further information.
+ * See the general documentation of this namespace for further information.
*
* In 1d, the default value of the boundary quadrature formula is an invalid
* object since integration on the boundary doesn't happen in 1d.
* Thus, the elements in the component mask corresponding to the components
* of these non-primitive shape functions must be @p false.
*
- * See the general documentation of this class for more information.
+ * See the general documentation of this namespace for more information.
*/
template <class DH>
void
* Thus, the elements in the component mask corresponding to the components
* of these non-primitive shape functions must be @p false.
*
- * See the general documentation of this class for more information.
+ * See the general documentation of this namespace for more information.
*
* @ingroup constraints
*/
* Create a right hand side vector. Prior content of the given @p rhs_vector
* vector is deleted.
*
- * See the general documentation of this class for further information.
+ * See the general documentation of this namespace for further information.
*/
template <int dim, int spacedim>
void create_right_hand_side (const Mapping<dim, spacedim> &mapping,
* \delta(x-p) \phi_i(x) dx$. Prior content of the given @p rhs_vector
* vector is deleted.
*
- * See the general documentation of this class for further information.
+ * See the general documentation of this namespace for further information.
*/
template <int dim, int spacedim>
void create_point_source_vector(const Mapping<dim,spacedim> &mapping,
*
* Prior content of the given @p rhs_vector vector is deleted.
*
- * See the general documentation of this class for further information.
+ * See the general documentation of this namespace for further information.
*/
template <int dim, int spacedim>
void create_point_source_vector(const Mapping<dim,spacedim> &mapping,
* Create a right hand side vector from boundary forces. Prior content of
* the given @p rhs_vector vector is deleted.
*
- * See the general documentation of this class for further information.
+ * See the general documentation of this namespace for further information.
*
* @see
* @ref GlossBoundaryIndicator "Glossary entry on boundary indicators"
* than NormType::Lp_norm or NormType::W1p_norm is chosen.
*
*
- * See the general documentation of this class for more information.
+ * See the general documentation of this namespace for more information.
*
* @note If the integration here happens over the cells of a
* parallel::distribute::Triangulation object, then this function computes
* norm of the error.
*
* Instantiations for this template are provided for some vector types (see
- * the general documentation of the class), but only for InVectors as in the
- * documentation of the class, OutVector only Vector<double> and
+ * the general documentation of the namespace), but only for InVectors as in
+ * the documentation of the namespace, OutVector only Vector<double> and
* Vector<float>.
*/
template <int dim, class InVector, class OutVector, int spacedim>
projects / dealii.git / commitdiff