Commit 6be74a63 authored by GILLES Sebastien's avatar GILLES Sebastien

#1601 Modify the field about comments in clang format style so that it doesn't...

#1601 Modify the field about comments in clang format style so that it doesn't butcher some Doxygen comments...
parent 15d5a491
Pipeline #204052 passed with stages
in 84 minutes and 1 second
......@@ -55,7 +55,7 @@ BreakConstructorInitializers: BeforeColon
BreakAfterJavaFieldAnnotations: false
BreakStringLiterals: true
ColumnLimit: 120
CommentPragmas: '^ IWYU pragma:'
CommentPragmas: '^(\\.+| IWYU pragma:)' # thanks to https://stackoverflow.com/questions/48016641/force-clang-format-to-respect-doxygen-block-comments
CompactNamespaces: false
ConstructorInitializerAllOnOneLineOrOnePerLine: false
ConstructorInitializerIndentWidth: 0
......
......@@ -223,8 +223,8 @@ namespace MoReFEM
* \param[in] extended_unknown Couple (\a Unknown, \a NumberingSubset) for which new node is to be
* created. \param[in] Ncomponent Number of dofs to create in association with the new node.
* \param[in,out] node_bearer \a NodeBearer upon which new node is created. It is modified as well as
* new node is actually stored there. \copydoc
* doxygen_hide_create_node_list_helper_param_node_for_current_finite_element
* new node is actually stored there.
* \copydoc doxygen_hide_create_node_list_helper_param_node_for_current_finite_element
*/
template<class LocalDofOnInterfaceT>
void CreateNodeList(const LocalDofOnInterfaceT& local_node_on_interface_list,
......
......@@ -57,7 +57,9 @@ namespace MoReFEM
* \param[in,out] node_bearer_list Node bearer list is still the same length in output (reduction not yet
* done) but its elements are sort differently: those to be on first processor comes first, then those on
* second one, and so on... Program-wise numbering is also applied: each of them gets as program-wise index
* its position in the new vector. \copydetails doxygen_hide_mpi_param \param[in] felt_space_list List of
* its position in the new vector.
* \copydetails doxygen_hide_mpi_param
* \param[in] felt_space_list List of
* finite element spaces in the god of dof that called present function.
*/
void PreparePartition(const ::MoReFEM::Wrappers::Mpi& mpi,
......@@ -86,7 +88,8 @@ namespace MoReFEM
* \copydoc doxygen_hide_mpi_param
* \param[in,out] processor_wise_node_bearer_list List of processor-wise \a NodeBearer. This is also an
* output parameter as these objects may have their content modified: the number of processors that ghost
* them may be added (it is the only change) \param[in] ghost_node_bearer_list List of ghost \a NodeBearer,
* them may be added (it is the only change)
* \param[in] ghost_node_bearer_list List of ghost \a NodeBearer,
* which will be shared with the other ranks.
*/
void BroadcastGhostNodeBearerIndexList(const ::MoReFEM::Wrappers::Mpi& mpi,
......
......@@ -121,11 +121,11 @@ namespace MoReFEM
* documentation](https://www.mcs.anl.gov/petsc/petsc-current/docs/manualpages/SNES/SNESJacobianFunction.html#SNESJacobianFunction)
* * tangent is the <i>output</i> tangent computed (\a Amat in aforementioned PETSc documentation).
* * preconditioner is the <i>output</i> preconditioner computed (\a Pmat in aforementioned PETSc
* documentation). \attention \a ComputeResidual() and \a ComputeTangent() are expected to be solely internal
* functions for SNESSolve(); you may use them directly if you wish but in this case, you must ensure yourself that
* input and output arguments have the correct layout and that output values are properly zeroed. \attention This
* class is specifically designed to be derived <b>once</b> (or at least that the mandatory methods are dfined
* directly in \a DerivedT).
* documentation).
* \attention \a ComputeResidual() and \a ComputeTangent() are expected to be solely internal functions for SNESSolve(); you may use them
* directly if you wish but in this case, you must ensure yourself that input and output arguments have the correct
* layout and that output values are properly zeroed.
* \attention This class is specifically designed to be derived <b>once</b> (or at least that the mandatory methods are dfined directly in \a DerivedT).
*
*/
// clang-format off
......@@ -517,9 +517,10 @@ namespace MoReFEM
*
* \tparam IndexT Input parameter that gives away the relevant informations is
* InputDataNS::InitialCondition<IndexT>. \tparam InputDataT Type of the structure that holds the model
* settings. \copydoc doxygen_hide_input_data_arg \param[in] numbering_subset \a NumberingSubset related to the
* \a unknown in the \a felt_space. \param[in] felt_space \a FEltSpace onto which the vector is to be
* initialized. \param[in] unknown \a Unknown considered in the vector.
* settings.
* \copydoc doxygen_hide_input_data_arg
* \param[in] numbering_subset \a NumberingSubset related to the \a unknown in the \a felt_space.
* \param[in] felt_space \a FEltSpace onto which the vector is to be initialized. \param[in] unknown \a Unknown considered in the vector.
*
*/
......
......@@ -206,8 +206,9 @@ namespace MoReFEM
*
* \param[in,out] existing_list List of all vertice that have been built so far for the enclosing
* geometric mesh. If a vertex already exists, point to the already existing object instead of
* recreating one. If not, create a new object from scratch and add it in the existing_list. \copydoc
* doxygen_hide_geom_elt_build_interface_ptr
* recreating one. If not, create a new object from scratch and add it in the existing_list.
*
* \copydoc doxygen_hide_geom_elt_build_interface_ptr
*/
virtual void BuildVertexList(const GeometricElt* geom_elt_ptr,
Vertex::InterfaceMap& existing_list) override final;
......@@ -218,8 +219,9 @@ namespace MoReFEM
*
* \param[in,out] existing_list List of all edges that have been built so far for the enclosing
* geometric mesh. If an edge already exists, point to the already existing object instead of recreating
* one. If not, create a new object from scratch and add it in the existing_list. \copydoc
* doxygen_hide_geom_elt_build_interface_ptr
* one. If not, create a new object from scratch and add it in the existing_list.
*
* \copydoc doxygen_hide_geom_elt_build_interface_ptr
*
*/
virtual void BuildEdgeList(const GeometricElt* geom_elt_ptr,
......@@ -230,8 +232,9 @@ namespace MoReFEM
*
* \param[in,out] existing_list List of all faces that have been built so far for the enclosing
* geometric mesh. If a face already exists, point to the already existing object instead of recreating
* one. If not, create a new object from scratch and add it in the existing_list. \copydoc
* doxygen_hide_geom_elt_build_interface_ptr
* one. If not, create a new object from scratch and add it in the existing_list.
*
* \copydoc doxygen_hide_geom_elt_build_interface_ptr
*
*/
virtual void BuildFaceList(const GeometricElt* geom_elt_ptr,
......
......@@ -59,11 +59,12 @@ namespace MoReFEM
/*!
* \brief Constructor.
*
* \param[in] extended_unknown_list List of unknowns considered by the operator. Its type
* (vector_shared_ptr) is due to constraints from genericity; for current operator it is expected to
* hold exactly two unknowns (the first one vectorial and the second one scalar). \copydoc
* doxygen_hide_test_extended_unknown_list_param \param[in] elementary_data Elementary matrices and
* vectors that will perform the calculations. \param[in] density Density as a \a Parameter.
* \param[in] extended_unknown_list List of unknowns considered by the operator. Its type (vector_shared_ptr)
* is due to constraints from genericity; for current operator it is expected to hold exactly
* two unknowns (the first one vectorial and the second one scalar).
* \copydoc doxygen_hide_test_extended_unknown_list_param
* \param[in] elementary_data Elementary matrices and vectors that will perform the calculations.
* \param[in] density Density as a \a Parameter.
*
* \internal <b><tt>[internal]</tt></b> This constructor must not be called manually: it is involved
* only in GlobalVariationalOperator<DerivedT, LocalVariationalOperatorT>::CreateLocalOperatorList()
......
......@@ -69,17 +69,22 @@ namespace MoReFEM
*
* \param[in] extended_unknown_list List of unknowns considered by the operators. Its type
* (vector_shared_ptr) is due to constraints from genericity; for current operator it is expected to
* hold exactly two unknowns (the first one vectorial and the second one scalar). \copydoc
* doxygen_hide_test_extended_unknown_list_param \param[in] elementary_data Elementary matrices and
* vectors that will perform the calculations. \param[in] intracellular_trans_diffusion_tensor
* Intracellular trans diffusion tensor. \param[in] extracellular_trans_diffusion_tensor Extracellular
* hold exactly two unknowns (the first one vectorial and the second one scalar).
* \copydoc doxygen_hide_test_extended_unknown_list_param
* \param[in] elementary_data Elementary matrices and
* vectors that will perform the calculations.
* \param[in] intracellular_trans_diffusion_tensor
* Intracellular trans diffusion tensor.
* \param[in] extracellular_trans_diffusion_tensor Extracellular
* trans diffusion tensor. \param[in] intracellular_fiber_diffusion_tensor Intracellular fiber diffusion
* tensor. \param[in] extracellular_fiber_diffusion_tensor Extracellular fiber diffusion tensor.
* tensor.
* \param[in] extracellular_fiber_diffusion_tensor Extracellular fiber diffusion tensor.
* \param[in] fibers Vectorial fibers.
*
* \internal <b><tt>[internal]</tt></b> This constructor must not be called manually: it is involved
* only in GlobalVariationalOperator<DerivedT, LocalVariationalOperatorT>::CreateLocalOperatorList()
* method. \endinternal
* method.
* \endinternal
*/
explicit Bidomain(
const ExtendedUnknown::vector_const_shared_ptr& extended_unknown_list,
......
......@@ -74,11 +74,12 @@ namespace MoReFEM
*
* \param[in] extended_unknown_list List of unknowns considered by the operators. Its type
* (vector_shared_ptr) is due to constraints from genericity; for current operator it is expected to
* hold exactly two unknowns (the first one vectorial and the second one scalar). \copydoc
* doxygen_hide_test_extended_unknown_list_param \param[in] elementary_data Elementary matrices and
* vectors that will perform the calculations. \param[in] transverse_diffusion_tensor
* transverse_diffusion_tensor \param[in] fiber_diffusion_tensor fiber_diffusion_tensor \param[in]
* fibers Fibers. \param[in] angles Angles.
* hold exactly two unknowns (the first one vectorial and the second one scalar).
* \copydoc doxygen_hide_test_extended_unknown_list_param
* \param[in] elementary_data Elementary matrices and vectors that will perform the calculations.
* \param[in] transverse_diffusion_tensor transverse_diffusion_tensor
* \param[in] fiber_diffusion_tensor fiber_diffusion_tensor
* \param[in] fibers Fibers. \param[in] angles Angles.
*
* \internal <b><tt>[internal]</tt></b> This constructor must not be called manually: it is involved
* only in GlobalVariationalOperator<DerivedT, LocalVariationalOperatorT>::CreateLocalOperatorList()
......
......@@ -69,11 +69,12 @@ namespace MoReFEM
*
* \param[in] extended_unknown_list List of unknowns considered by the operators. Its type
* (vector_shared_ptr) is due to constraints from genericity; for current operator it is expected to
* hold exactly two unknowns (the first one vectorial and the second one scalar). \copydoc
* doxygen_hide_test_extended_unknown_list_param \param[in] elementary_data Elementary matrices and
* vectors that will perform the calculations. \param[in] transverse_diffusion_tensor Transverse
* diffusion tensor. \param[in] fiber_diffusion_tensor Fiber diffusion tensor. \param[in] fibers
* Vectorial fibers.
* hold exactly two unknowns (the first one vectorial and the second one scalar).
* \copydoc doxygen_hide_test_extended_unknown_list_param
* \param[in] elementary_data Elementary matrices and vectors that will perform the calculations.
* \param[in] transverse_diffusion_tensor Transverse diffusion tensor.
* \param[in] fiber_diffusion_tensor Fiber diffusion tensor.
* \param[in] fibers Vectorial fibers.
*
* \internal <b><tt>[internal]</tt></b> This constructor must not be called manually: it is involved
* only in GlobalVariationalOperator<DerivedT, LocalVariationalOperatorT>::CreateLocalOperatorList()
......
......@@ -76,9 +76,9 @@ namespace MoReFEM
*
* \param[in] extended_unknown_list List of unknowns considered by the operators. Its type
* (vector_shared_ptr) is due to constraints from genericity; for current operator it is expected to
* hold exactly two unknowns (the first one vectorial and the second one scalar). \copydoc
* doxygen_hide_test_extended_unknown_list_param \param[in] elementary_data Elementary matrices and
* vectors that will perform the calculations.
* hold exactly two unknowns (the first one vectorial and the second one scalar).
* \copydoc doxygen_hide_test_extended_unknown_list_param
* \param[in] elementary_data Elementary matrices and vectors that will perform the calculations.
*
* \internal <b><tt>[internal]</tt></b> This constructor must not be called manually: it is involved
* only in GlobalVariationalOperator<DerivedT, LocalVariationalOperatorT>::CreateLocalOperatorList()
......
......@@ -65,9 +65,10 @@ namespace MoReFEM
*
* \param[in] extended_unknown_list List of unknowns considered by the operators. Its type
* (vector_shared_ptr) is due to constraints from genericity; for current operator it is expected to
* hold exactly two unknowns (the first one vectorial and the second one scalar). \copydoc
* doxygen_hide_test_extended_unknown_list_param \param[in] elementary_data Elementary matrices and
* vectors that will perform the calculations. \param[in] fluid_viscosity Viscosity of the fluid.
* hold exactly two unknowns (the first one vectorial and the second one scalar).
* \copydoc doxygen_hide_test_extended_unknown_list_param
* \param[in] elementary_data Elementary matrices and vectors that will perform the calculations.
* \param[in] fluid_viscosity Viscosity of the fluid.
*
* \internal <b><tt>[internal]</tt></b> This constructor must not be called manually: it is involved
* only in GlobalVariationalOperator<DerivedT, LocalVariationalOperatorT>::CreateLocalOperatorList()
......
......@@ -90,9 +90,9 @@ namespace MoReFEM
*
* \param[in] extended_unknown_list List of unknowns considered by the operators. Its type
* (vector_shared_ptr) is due to constraints from genericity; for current operator it is expected to
* hold exactly two unknowns (the first one vectorial and the second one scalar). \copydoc
* doxygen_hide_test_extended_unknown_list_param \param[in] elementary_data Elementary matrices and
* vectors that will perform the calculations.
* hold exactly two unknowns (the first one vectorial and the second one scalar).
* \copydoc doxygen_hide_test_extended_unknown_list_param
* \param[in] elementary_data Elementary matrices and vectors that will perform the calculations.
*
* \internal <b><tt>[internal]</tt></b> This constructor must not be called manually: it is involved
* only in GlobalVariationalOperator<DerivedT, LocalVariationalOperatorT>::CreateLocalOperatorList()
......
......@@ -87,10 +87,10 @@ namespace MoReFEM
*
* \param[in] extended_unknown_list List of unknowns considered by the operators. Its type
* (vector_shared_ptr) is due to constraints from genericity; for current operator it is expected to
* hold exactly two unknowns (the first one vectorial and the second one scalar). \copydoc
* doxygen_hide_test_extended_unknown_list_param \param[in] elementary_data Elementary matrices and
* vectors that will perform the calculations. \param[in] pressure \a Parameter which holds static
* pressure values.
* hold exactly two unknowns (the first one vectorial and the second one scalar).
* \copydoc doxygen_hide_test_extended_unknown_list_param
* \param[in] elementary_data Elementary matrices and vectors that will perform the calculations
* \param[in] pressure \a Parameter which holds static pressure values.
*
* \internal <b><tt>[internal]</tt></b> This constructor must not be called manually: it is involved
* only in GlobalVariationalOperator<DerivedT, LocalVariationalOperatorT>::CreateLocalOperatorList()
......
......@@ -75,9 +75,10 @@ namespace MoReFEM
*
* \param[in] extended_unknown_list List of unknowns considered by the operators. Its type
* (vector_shared_ptr) is due to constraints from genericity; for current operator it is expected to
* hold exactly two unknowns (the first one vectorial and the second one scalar). \copydoc
* doxygen_hide_test_extended_unknown_list_param \param[in] elementary_data Elementary matrices and
* vectors that will perform the calculations. \param[in] youngs_modulus Young's modulus of the solid.
* hold exactly two unknowns (the first one vectorial and the second one scalar).
* \copydoc doxygen_hide_test_extended_unknown_list_param
* \param[in] elementary_data Elementary matrices and vectors that will perform the calculations.
* \param[in] youngs_modulus Young's modulus of the solid.
* \param[in] poisson_ratio Poisson ratio of the solid.
* \param[in] thickness Thickness of the solid.
* \param[in] pretension Pretension (related computation are skipped if the underlying value is 0.).
......
......@@ -101,9 +101,10 @@ namespace MoReFEM
*
* \param[in] extended_unknown_list List of unknowns considered by the operators. Its type
* (vector_shared_ptr) is due to constraints from genericity; for current operator it is expected to
* hold exactly two unknowns (the first one vectorial and the second one scalar). \copydoc
* doxygen_hide_test_extended_unknown_list_param \param[in] elementary_data Elementary matrices and
* vectors that will perform the calculations. \param[in] hydrostatic_law Hydrostatic law policy; do not
* hold exactly two unknowns (the first one vectorial and the second one scalar).
* \copydoc doxygen_hide_test_extended_unknown_list_param
* \param[in] elementary_data Elementary matrices and vectors that will perform the calculations.
* \param[in] hydrostatic_law Hydrostatic law policy; do not
* delete this pointer! \param[in] cauchy_green_tensor Cauchy-Green tensor of the related second
* Piola-Kirchhoff stress tensor.
*
......
......@@ -96,11 +96,11 @@ namespace MoReFEM
*
* \param[in] extended_unknown_list List of unknowns considered by the operators. Its type
* (vector_shared_ptr) is due to constraints from genericity; for current operator it is expected to
* hold exactly two unknowns (the first one vectorial and the second one scalar). \copydoc
* doxygen_hide_test_extended_unknown_list_param \param[in] elementary_data Elementary matrices and
* vectors that will perform the calculations. \param[in] hydrostatic_law Hydrostatic law policy; do not
* delete this pointer! \param[in] cauchy_green_tensor Cauchy-Green tensor of the related second
* Piola-Kirchhoff stress tensor.
* hold exactly two unknowns (the first one vectorial and the second one scalar).
* \copydoc doxygen_hide_test_extended_unknown_list_param
* \param[in] elementary_data Elementary matrices and vectors that will perform the calculations.
* \param[in] hydrostatic_law Hydrostatic law policy; do not delete this pointer! \param[in] cauchy_green_tensor
* Cauchy-Green tensor of the related second Piola-Kirchhoff stress tensor.
*
* \internal <b><tt>[internal]</tt></b> This constructor must not be called manually: it is involved
* only in GlobalVariationalOperator<DerivedT, LocalVariationalOperatorT>::CreateLocalOperatorList()
......
......@@ -125,13 +125,15 @@ namespace MoReFEM
*
* \param[in] extended_unknown_list List of unknowns considered by the operators. Its type
* (vector_shared_ptr) is due to constraints from genericity; for current operator it is expected to
* hold exactly one vectorial unknown (as long as #7 is not implemented at the very least...) \copydoc
* doxygen_hide_test_extended_unknown_list_param \param[in] elementary_data Elementary matrices and
* vectors that will perform the calculations. \param[in] solid Object which provides the required
* material parameters for the solid. \param[in] hyperelastic_law The hyperelastic law if there is an
* hyperelastic part in the operator, or nullptr otherwise. Example of hyperelasticlaw is
* MoReFEM::HyperelasticLawNS::CiarletGeymonat. \copydoc doxygen_hide_time_manager_arg \param[in]
* input_internal_variable_policy Object involved with the internal variable (such as active stress)
* hold exactly one vectorial unknown (as long as #7 is not implemented at the very least...)
*
* \copydoc doxygen_hide_test_extended_unknown_list_param
* \param[in] elementary_data Elementary matrices and vectors that will perform the calculations.
* \param[in] solid Object which provides the required material parameters for the solid.
* \param[in] hyperelastic_law The hyperelastic law if there is an hyperelastic part in the operator, or nullptr otherwise.
* Example of hyperelasticlaw is MoReFEM::HyperelasticLawNS::CiarletGeymonat.
* \copydoc doxygen_hide_time_manager_arg
* \param[in] input_internal_variable_policy Object involved with the internal variable (such as active stress)
* policy.
*
* \internal <b><tt>[internal]</tt></b> This constructor must not be called manually: it is involved
......
......@@ -15,9 +15,9 @@
#ifndef MOREFEM_x_OPERATORS_x_GLOBAL_VARIATIONAL_OPERATOR_x_ADVANCED_x_LOCAL_OPERATOR_TUPLE_ITEM_HPP_
#define MOREFEM_x_OPERATORS_x_GLOBAL_VARIATIONAL_OPERATOR_x_ADVANCED_x_LOCAL_OPERATOR_TUPLE_ITEM_HPP_
#include <cassert>
#include <memory>
#include <vector>
#include <cassert>
#include "Geometry/GeometricElt/Advanced/GeometricEltEnum.hpp"
......
......@@ -99,11 +99,13 @@ namespace MoReFEM
* is the one calling current static method).
* \copydoc doxygen_hide_global_operator_local_operator_tuple_inout
* \param[in] additional_args_as_tuple List of variadic arguments given to the
* GlobalOperatorT::Assemble() operator grouped together within a tuple. \copydoc
* doxygen_hide_gvo_assemble_domain_arg \copydoc doxygen_hide_linear_algebra_tuple_arg \copydoc
* doxygen_hide_gvo_elementary_mode_tparam \param[in] do_assemble_into_matrix Whether the \a
* GlobalVariationalOperator Assemble() call targets at least one matrix. \param[in]
* do_assemble_into_vector Whether the \a GlobalVariationalOperator Assemble() call targets at least one
* GlobalOperatorT::Assemble() operator grouped together within a tuple.
* \copydoc doxygen_hide_gvo_assemble_domain_arg
* \copydoc doxygen_hide_linear_algebra_tuple_arg
* \copydoc doxygen_hide_gvo_elementary_mode_tparam
* \param[in] do_assemble_into_matrix Whether the \a
* GlobalVariationalOperator Assemble() call targets at least one matrix.
* \param[in] do_assemble_into_vector Whether the \a GlobalVariationalOperator Assemble() call targets at least one
* vector.
*/
template<elementary_mode ModeT,
......
......@@ -85,11 +85,11 @@ namespace MoReFEM
* required data). \param[in] quadrature_rule Quadrature rule to use for the enclosing local operator.
* \param[in] unknown_storage List of unknowns involved in the current local operator. This must be a
* subset of the ones in the enclosing FEltSpace; however there is no need to follow the same ordering
* (ordering is specified at the LocalVariationalOperator level). \param[in] test_unknown_storage List
* of all the pair test_unknown/numbering subset considered by the operator. \param[in]
* felt_space_dimension Dimension considered in the finite element space. \param[in] mesh_dimension
* Dimension in the mesh. Must be equal or higher than felt_space_dimension. \copydoc
* doxygen_hide_operator_do_allocate_gradient_felt_phi_arg
* (ordering is specified at the LocalVariationalOperator level).
* \param[in] test_unknown_storage List of all the pair test_unknown/numbering subset considered by the operator.
* \param[in] felt_space_dimension Dimension considered in the finite element space.
* \param[in] mesh_dimension Dimension in the mesh. Must be equal or higher than felt_space_dimension.
* \copydoc doxygen_hide_operator_do_allocate_gradient_felt_phi_arg
*/
explicit ElementaryDataImpl(const Internal::RefFEltNS::RefLocalFEltSpace& ref_felt_space,
const QuadratureRule& quadrature_rule,
......
......@@ -150,21 +150,25 @@ namespace MoReFEM
/// \name Special members.
///@{
/*!
*
* \brief Constructor.
*
* \param[in] unique_id Unique id of the FilberList as read in the input file.
* \param[in] fiber_file File at the Ensight format which will be interpreted. Its format is specified by
* Ensight specifications; typically scalar files get a 'scl' extension and their first line is 'Scalar per
* node' whereas vectorial get a 'vct' extension and first line is 'Vector per node'. \param[in] domain \a
* Domain considered for the parameters; in peculiar vertices to consider will be taken from there. \param[in]
* felt_space Finite element space upon which the Parameter should be defined. \param[in] unknown A scalar or
* vectorial unknown that acts a bit as a strawman: dofs are defined only in relationship to an unknown, so you
* must create one if none fulfill your purposes (for instance if you deal with a vectorial unknown and need a
* scalar Dof field, you must create another unknown only for the Parameter. To save space, it's better if this
* unknown is in its own numbering subset, but this is not mandatory. Unknown should be scalar for TypeT ==
* ParameterNS::Type::scalar and vectorial for TypeT == ParameterNS::Type::vectorial. \copydetails
* doxygen_hide_time_manager_arg
* node' whereas vectorial get a 'vct' extension and first line is 'Vector per node'.
* \param[in] domain \a Domain considered for the parameters; in peculiar vertices to consider will
* be taken from there.
* \param[in] felt_space Finite element space upon which the Parameter should be defined.
* \param[in] unknown A scalar or vectorial unknown that acts a bit as a strawman: dofs are defined only
* in relationship to an unknown, so you must create one if none fulfill your purposes (for instance
* if you deal with a vectorial unknown and need a scalar Dof field, you must create another unknown
* only for the Parameter. To save space, it's better if this unknown is in its own numbering subset,
* but this is not mandatory. Unknown should be scalar for TypeT == ParameterNS::Type::scalar and vectorial
* for TypeT == ParameterNS::Type::vectorial.
* \copydetails doxygen_hide_time_manager_arg
*
*/
explicit FiberList(unsigned int unique_id,
......
......@@ -563,9 +563,10 @@ namespace MoReFEM
/*!
* \brief Wrapper over MatView in the case the viewer is a binary file.
*
* \param[in] output_file File into which the vector content will be written. This file will be written
* only on the root processor; for other ranks nothing is written at all. \copydoc
* doxygen_hide_invoking_file_and_line \copydoc doxygen_hide_mpi_param
* \param[in] output_file File into which the vector content will be written. This file will be written only on the root processor; for other
* ranks nothing is written at all.
* \copydoc doxygen_hide_invoking_file_and_line
* \copydoc doxygen_hide_mpi_param
*/
void ViewBinary(const Mpi& mpi,
const std::string& output_file,
......
......@@ -399,10 +399,11 @@ namespace MoReFEM
*
* \copydoc doxygen_hide_petsc_vec_assembly
*
* \param[in] indexing All indexes (program-wise) that have to be modified in the vector are stored
* here. \param[in] values Values to put in the vector. This array should be the same size as \a
* indexing (unfortunately we can't check that here as it is a C array) \param [in] insertOrAppend Petsc
* ADD_VALUES or INSERT_VALUES (see Petsc documentation). \copydoc doxygen_hide_invoking_file_and_line
* \param[in] indexing All indexes (program-wise) that have to be modified in the vector are stored here.
* \param[in] values Values to put in the vector. This array should be the same size as \a indexing
* (unfortunately we can't check that here as it is a C array)
* \param [in] insertOrAppend Petsc ADD_VALUES or INSERT_VALUES (see Petsc documentation).
* \copydoc doxygen_hide_invoking_file_and_line
*
*/
void SetValues(const std::vector<PetscInt>& indexing,
......@@ -417,10 +418,10 @@ namespace MoReFEM
*
* \copydoc doxygen_hide_petsc_vec_assembly
*
* \param[in] indexing All indexes (program-wise) (program-wise) that have to be modified in the vector
* are stored here. \param[in] local_vec Local vector which values will be put inside vector. \param
* [in] insertOrAppend Petsc ADD_VALUES or INSERT_VALUES (see Petsc documentation). \copydoc
* doxygen_hide_invoking_file_and_line
* \param[in] indexing All indexes (program-wise) (program-wise) that have to be modified in the vector are stored here.
* \param[in] local_vec Local vector which values will be put inside vector.
* \param [in] insertOrAppend Petsc ADD_VALUES or INSERT_VALUES (see Petsc documentation).
* \copydoc doxygen_hide_invoking_file_and_line
*/
template<Utilities::Access AccessT>
void SetValues(const std::vector<PetscInt>& indexing,
......@@ -663,8 +664,8 @@ namespace MoReFEM
* formats available; relevant ones so far are PETSC_VIEWER_DEFAULT and PETSC_VIEWER_ASCII_MATLAB.
* \param[in] invoking_file File that invoked the function or class; usually __FILE__.
* \param[in] invoking_line File that invoked the function or class; usually __LINE__.
* \param[in] mpi Mpi object which knows the rank of the processor, the total number of processors,
* etc... \param[in] input_file File into which the vector content will be loaded.
* \param[in] mpi Mpi object which knows the rank of the processor, the total number of processors, etc...
* \param[in] input_file File into which the vector content will be loaded.
*/
void Load(const Mpi& mpi,
const std::string& input_file,
......
......@@ -11,7 +11,7 @@
#ifndef MOREFEM_x_UTILITIES_x_TYPE_x_STRONG_TYPE_x_SKILLS_x_PRINTABLE_HPP_
#define MOREFEM_x_UTILITIES_x_TYPE_x_STRONG_TYPE_x_SKILLS_x_PRINTABLE_HPP_
# include <iosfwd>
#include <iosfwd>
namespace MoReFEM::StrongTypeNS
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment