From: Wolfgang Bangerth Date: Tue, 18 Aug 2015 13:38:49 +0000 (-0500) Subject: Sort members of MappingCartesian into doxygen groups. X-Git-Tag: v8.4.0-rc2~575^2~2 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=6d3a94f94af5db052d654507f20e48a2f5a0f4b3;p=dealii.git Sort members of MappingCartesian into doxygen groups. Also make a virtual function non-inline. --- diff --git a/include/deal.II/fe/mapping_cartesian.h b/include/deal.II/fe/mapping_cartesian.h index 120c62047a..433bdc7bd0 100644 --- a/include/deal.II/fe/mapping_cartesian.h +++ b/include/deal.II/fe/mapping_cartesian.h @@ -54,73 +54,58 @@ template class MappingCartesian : public Mapping { public: -private: + + // for documentation, see the Mapping base class + virtual + Mapping *clone () const; /** - * @name Interface with FEValues - * @{ + * Always returns @p true because MappingCartesian preserves vertex + * locations. */ + bool preserves_vertex_locations () const; - // documentation can be found in Mapping::get_data() - virtual - typename Mapping::InternalDataBase * - get_data (const UpdateFlags, - const Quadrature &quadrature) const; - - // documentation can be found in Mapping::get_face_data() - virtual - typename Mapping::InternalDataBase * - get_face_data (const UpdateFlags flags, - const Quadrature& quadrature) const; + /** + * @name Mapping points between reference and real cells + * @{ + */ - // documentation can be found in Mapping::get_subface_data() + // for documentation, see the Mapping base class virtual - typename Mapping::InternalDataBase * - get_subface_data (const UpdateFlags flags, - const Quadrature& quadrature) const; + Point + transform_unit_to_real_cell (const typename Triangulation::cell_iterator &cell, + const Point &p) const; - // documentation can be found in Mapping::fill_fe_values() + // for documentation, see the Mapping base class virtual - CellSimilarity::Similarity - fill_fe_values (const typename Triangulation::cell_iterator &cell, - const CellSimilarity::Similarity cell_similarity, - const Quadrature &quadrature, - const typename Mapping::InternalDataBase &internal_data, - internal::FEValues::MappingRelatedData &output_data) const; - - // documentation can be found in Mapping::fill_fe_face_values() - virtual void - fill_fe_face_values (const typename Triangulation::cell_iterator &cell, - const unsigned int face_no, - const Quadrature &quadrature, - const typename Mapping::InternalDataBase &internal_data, - internal::FEValues::MappingRelatedData &output_data) const; - - // documentation can be found in Mapping::fill_fe_subface_values() - virtual void - fill_fe_subface_values (const typename Triangulation::cell_iterator &cell, - const unsigned int face_no, - const unsigned int subface_no, - const Quadrature &quadrature, - const typename Mapping::InternalDataBase &internal_data, - internal::FEValues::MappingRelatedData &output_data) const; + Point + transform_real_to_unit_cell (const typename Triangulation::cell_iterator &cell, + const Point &p) const; /** * @} */ + /** + * @name Functions to transform tensors from reference to real coordinates + * @{ + */ + + // for documentation, see the Mapping base class virtual void transform (const VectorSlice > > input, VectorSlice > > output, const typename Mapping::InternalDataBase &internal, const MappingType type) const; + // for documentation, see the Mapping base class virtual void transform (const VectorSlice > > input, VectorSlice > > output, const typename Mapping::InternalDataBase &internal, const MappingType type) const; + // for documentation, see the Mapping base class virtual void transform (const VectorSlice > > input, @@ -128,6 +113,7 @@ private: const typename Mapping::InternalDataBase &internal, const MappingType type) const; + // for documentation, see the Mapping base class virtual void transform (const VectorSlice > > input, @@ -135,6 +121,7 @@ private: const typename Mapping::InternalDataBase &internal, const MappingType type) const; + // for documentation, see the Mapping base class virtual void transform (const VectorSlice > > input, @@ -142,37 +129,18 @@ private: const typename Mapping::InternalDataBase &internal, const MappingType type) const; - virtual Point - transform_unit_to_real_cell ( - const typename Triangulation::cell_iterator &cell, - const Point &p) const; - /** - * Transforms the point @p p on the real cell to the point @p p_unit on the - * unit cell @p cell and returns @p p_unit. - * - * Uses Newton iteration and the @p transform_unit_to_real_cell function. + * @} */ - virtual Point - transform_real_to_unit_cell ( - const typename Triangulation::cell_iterator &cell, - const Point &p) const; - /** - * Return a pointer to a copy of the present object. The caller of this copy - * then assumes ownership of it. - */ - virtual - Mapping *clone () const; +private: /** - * Always returns @p true because MappingCartesian preserves vertex - * locations. + * @name Interface with FEValues + * @{ */ - bool preserves_vertex_locations () const; -protected: /** * Storage for internal data of the mapping. See Mapping::InternalDataBase * for an extensive description. @@ -214,6 +182,61 @@ protected: std::vector > quadrature_points; }; + // documentation can be found in Mapping::requires_update_flags() + virtual + UpdateFlags + requires_update_flags (const UpdateFlags update_flags) const; + + // documentation can be found in Mapping::get_data() + virtual + typename Mapping::InternalDataBase * + get_data (const UpdateFlags, + const Quadrature &quadrature) const; + + // documentation can be found in Mapping::get_face_data() + virtual + typename Mapping::InternalDataBase * + get_face_data (const UpdateFlags flags, + const Quadrature& quadrature) const; + + // documentation can be found in Mapping::get_subface_data() + virtual + typename Mapping::InternalDataBase * + get_subface_data (const UpdateFlags flags, + const Quadrature& quadrature) const; + + // documentation can be found in Mapping::fill_fe_values() + virtual + CellSimilarity::Similarity + fill_fe_values (const typename Triangulation::cell_iterator &cell, + const CellSimilarity::Similarity cell_similarity, + const Quadrature &quadrature, + const typename Mapping::InternalDataBase &internal_data, + internal::FEValues::MappingRelatedData &output_data) const; + + // documentation can be found in Mapping::fill_fe_face_values() + virtual void + fill_fe_face_values (const typename Triangulation::cell_iterator &cell, + const unsigned int face_no, + const Quadrature &quadrature, + const typename Mapping::InternalDataBase &internal_data, + internal::FEValues::MappingRelatedData &output_data) const; + + // documentation can be found in Mapping::fill_fe_subface_values() + virtual void + fill_fe_subface_values (const typename Triangulation::cell_iterator &cell, + const unsigned int face_no, + const unsigned int subface_no, + const Quadrature &quadrature, + const typename Mapping::InternalDataBase &internal_data, + internal::FEValues::MappingRelatedData &output_data) const; + + /** + * @} + */ + + + /** * Do the computation for the fill_* functions. */ @@ -225,12 +248,6 @@ protected: std::vector > &quadrature_points, std::vector > &normal_vectors) const; -private: - // documentation can be found in Mapping::requires_update_flags() - virtual - UpdateFlags - requires_update_flags (const UpdateFlags update_flags) const; - /** * Value to indicate that a given face or subface number is invalid. */ @@ -239,20 +256,6 @@ private: /*@}*/ -/* -------------- declaration of explicit specializations ------------- */ - -#ifndef DOXYGEN - -template -inline -bool -MappingCartesian::preserves_vertex_locations () const -{ - return true; -} - -#endif // DOXYGEN - DEAL_II_NAMESPACE_CLOSE #endif diff --git a/source/fe/mapping_cartesian.cc b/source/fe/mapping_cartesian.cc index cc0f59c8b2..d8c76310c2 100644 --- a/source/fe/mapping_cartesian.cc +++ b/source/fe/mapping_cartesian.cc @@ -56,6 +56,14 @@ MappingCartesian::InternalData::memory_consumption () const +template +bool +MappingCartesian::preserves_vertex_locations () const +{ + return true; +} + + template UpdateFlags