#9 Doxygen: define a generic definition for input parameter data and use it everywhere.

Sources/Core/InputParameterData/InputParameterList.hpp

@@ -24,6 +24,15 @@
 
 namespace HappyHeart
 {
+    
+    
+    /*!
+     *
+     * \class doxygen_hide_input_parameter_data_arg
+     *
+     * \param[in] input_parameter_data Object which hold the values of all the parameters defined in
+     * the input file.
+     */
    
 
     /*!

Sources/FiniteElement/FiniteElementSpace/GodOfDof.hpp

@@ -129,8 +129,7 @@ namespace HappyHeart
          * - Set the list of finite elements in each finite element space.
          * - Set the list of nodes here.
          *
-         * \param[in] input_parameter_data Object which hold the values of all the parameters defined in
-         * the input file.
+         * \copydoc doxygen_hide_input_parameter_data_arg
          * \param[in] felt_space_list List of all \a FEltSpace to consider in the \a GodOfDof.
          * \copydetails doxygen_hide_do_consider_processor_wise_local_2_global
          *
@@ -497,8 +496,7 @@ namespace HappyHeart
          * processor-wise are performed. The typical example here is data required by non conform interpolator, which
          * involves several GodOfDofs and can't therefore be handled solely by the clever Petsc mpi communications.
          *
-         * \param[in] input_parameter_data Object which hold the values of all the parameters defined in
-         * the input file.
+         * \copydoc doxygen_hide_input_parameter_data_arg
          */
         template<class InputParameterDataT>
         void Init2(const InputParameterDataT& input_parameter_data);

Sources/FiniteElement/FiniteElementSpace/Private/FEltSpace.hpp

@@ -39,7 +39,7 @@ namespace HappyHeart
              * \internal <b><tt>[internal]</tt></b> A factory function is used here due to the \a UniqueIdT template parameter: C++ grammar doesn't
              * allow an explicit template parameter in a non-template class constructor.
              *
-             * \param[in] input_parameter_data Object that packs the data read from the input parameter file.
+             * \copydoc doxygen_hide_input_parameter_data_arg
              *
              * \tparam UniqueIdT Unique id of the finite element space from which the domain is extracted.
              * This unique id is the one used in the input parameter file; it is for instance 5 for block tagged

Sources/FormulationSolver/Crtp/VolumicAndSurfacicSource.hpp

@@ -87,7 +87,7 @@ namespace HappyHeart
              * \brief Set one of the operator if it is tagged as activated in the input parameter file.
              *
              * \param[in] name Name of the parameter (for outputs).
-             * \param[in] input_parameter_data Data from the input parameter file.
+             * \copydoc doxygen_hide_input_parameter_data_arg
              * \param[in] felt_space Finite element space upon which the operator is defined.
              * \param[in] unknown Unknown considered for this operator (might be scalar or vectorial).
              * \param[in] geom_mesh_region_dimension Dimension of the geometric mesh region considered.

Sources/FormulationSolver/VariationalFormulation.hpp

@@ -140,8 +140,7 @@ namespace HappyHeart
          * Must be called immediately after the constructor (but it is already taken care of - see constructor
          * help for more details).
          *
-         * \param[in] input_parameter_data A InputParameterList object which includes and defines all the
-         * input parameters required for the formulation.
+         * \copydoc doxygen_hide_input_parameter_data_arg
          */
         template<class InputParameterDataT>
         void Init(const InputParameterDataT& input_parameter_data);

Sources/Model/Model.hpp

@@ -71,7 +71,7 @@ namespace HappyHeart
          * steps (for instance VariationalFormulation or dof numebering are fully built there).
          *
          * \param[in] mpi Object in charge of mpi.
-         * \param[in] input_parameter_data The object that holds the content of the input parameter file.
+         * \copydoc doxygen_hide_input_parameter_data_arg
          */
         template<class InputParameterDataT>
         explicit Model(const Wrappers::Mpi& mpi,
@@ -103,6 +103,8 @@ namespace HappyHeart
          * \internal <b><tt>[internal]</tt></b> Part of its implementation is the responsability of DerivedT: the base class just checks whether
          * maximum time has been hit, but it is possible for some model to add additional criteria through
          * SupplHasFinishedConditions().
+         *
+         * \return True if all time iterations are done.
          */
         bool HasFinished();
         
@@ -114,6 +116,8 @@ namespace HappyHeart
          * must be implemented in DerivedT::SupplInitialize() (this method must be defined even
          * in cases its content is null).
          *
+         * \copydoc doxygen_hide_input_parameter_data_arg
+         *
          */
         template<class InputParameterDataT>
         void Initialize(const InputParameterDataT& input_parameter_data);
@@ -224,6 +228,7 @@ namespace HappyHeart
         //! Output directory.
         std::string output_directory_;
         
+        //! Files will be written every \a display_value_ time iteration. Choose 1 to write all of them.
         unsigned int display_value_;
     };
 }

Sources/ModelInstances/AcousticWave/VariationalFormulation.hpp

@@ -144,8 +144,7 @@ namespace HappyHeart
             /*!
              * \brief Define the properties of all the global variational operators involved.
              *
-             * \param[in] input_parameter_data Object which hold the values of all the parameters defined in
-             * the input file.
+             * \copydoc doxygen_hide_input_parameter_data_arg
              */
             void DefineOperators(const InputParameterList& input_parameter_data);
             

Sources/ModelInstances/Bidomain/BidomainVariationalFormulation.hpp

@@ -195,8 +195,7 @@ namespace HappyHeart
             /*!
              * \brief Define the properties of all the global variational operators involved.
              *
-             * \param[in] input_parameter_data Object which hold the values of all the parameters defined in
-             * the input file.
+             * \copydoc doxygen_hide_input_parameter_data_arg
              */
             void DefineOperators(const InputParameterList& input_parameter_data);
             

Sources/ModelInstances/BidomainVentricles/BidomainVentriclesVariationalFormulation.hpp

@@ -191,8 +191,7 @@ namespace HappyHeart
             /*!
              * \brief Define the properties of all the global variational operators involved.
              *
-             * \param[in] input_parameter_data Object which hold the values of all the parameters defined in
-             * the input file.
+             * \copydoc doxygen_hide_input_parameter_data_arg
              */
             void DefineOperators(const InputParameterList& input_parameter_data);
             

Sources/ModelInstances/Elasticity/VariationalFormulationElasticity.hpp

@@ -196,8 +196,7 @@ namespace HappyHeart
             /*!
              * \brief Define the properties of all the global variational operators involved.
              *
-             * \param[in] input_parameter_data Object which hold the values of all the parameters defined in
-             * the input file.
+             * \copydoc doxygen_hide_input_parameter_data_arg
              */
             void DefineOperators(const InputParameterList& input_parameter_data);
             

Sources/ModelInstances/FSI_EI/AleElasticVariationalFormulation.hpp

@@ -153,8 +153,7 @@ namespace HappyHeart
             /*!
              * \brief Define the properties of all the global variational operators involved.
              *
-             * \param[in] input_parameter_data Object which hold the values of all the parameters defined in
-             * the input file.
+             * \copydoc doxygen_hide_input_parameter_data_arg
              */
             void DefineOperators(const InputParameterList& input_parameter_data);
 

Sources/ModelInstances/FSI_EI/SolidVariationalFormulationPolicy/Elasticity/VariationalFormulation.hpp

@@ -160,8 +160,7 @@ namespace HappyHeart
             /*!
              * \brief Define the properties of all the global variational operators involved.
              *
-             * \param[in] input_parameter_data Object which hold the values of all the parameters defined in
-             * the input file.
+             * \copydoc doxygen_hide_input_parameter_data_arg
              */
             void DefineOperators(const InputParameterList& input_parameter_data);
             

Sources/ModelInstances/Heat/HeatVariationalFormulation.hpp

@@ -196,8 +196,7 @@ namespace HappyHeart
             /*!
              * \brief Define the properties of all the global variational operators involved.
              *
-             * \param[in] input_parameter_data Object which hold the values of all the parameters defined in
-             * the input file.
+             * \copydoc doxygen_hide_input_parameter_data_arg
              */
             void DefineOperators(const InputParameterList& input_parameter_data);
             

Sources/ModelInstances/Hyperelasticity/HyperElasticityModel.hpp

@@ -70,7 +70,7 @@ namespace HappyHeart
              * \brief Constructor.
              *
              * \copydetails doxygen_hide_mpi_param
-             * \param[in] input_parameter_data Object that manages data from the input parameter file.
+             * \copydoc doxygen_hide_input_parameter_data_arg
              */
             explicit HyperElasticityModel(const Wrappers::Mpi& mpi,
                                           const InputParameterList& input_parameter_data);

Sources/ModelInstances/Hyperelasticity/VariationalFormulationHyperElasticity.hpp

@@ -217,8 +217,7 @@ namespace HappyHeart
             /*!
              * \brief Define the properties of all the global variational operators involved.
              *
-             * \param[in] input_parameter_data Object which hold the values of all the parameters defined in
-             * the input file.
+             * \copydoc doxygen_hide_input_parameter_data_arg
              */
             void DefineOperators(const InputParameterList& input_parameter_data);
 

Sources/ModelInstances/Legacy/FSI_EI_One_Mesh/SolidVariationalFormulationPolicy/Elasticity/VariationalFormulation.hpp

@@ -161,8 +161,7 @@ namespace HappyHeart
             /*!
              * \brief Define the properties of all the global variational operators involved.
              *
-             * \param[in] input_parameter_data Object which hold the values of all the parameters defined in
-             * the input file.
+             * \copydoc doxygen_hide_input_parameter_data_arg
              */
             void DefineOperators(const InputParameterList& input_parameter_data);
             

Sources/ModelInstances/ReactionDiffusion/ReactionDiffusionVariationalFormulation.hpp

@@ -188,8 +188,7 @@ namespace HappyHeart
             /*!
              * \brief Define the properties of all the global variational operators involved.
              *
-             * \param[in] input_parameter_data Object which hold the values of all the parameters defined in
-             * the input file.
+             * \copydoc doxygen_hide_input_parameter_data_arg
              */
             void DefineOperators(const InputParameterList& input_parameter_data);
             

Sources/ModelInstances/Stokes/VariationalFormulation.hpp

@@ -164,8 +164,7 @@ namespace HappyHeart
             /*!
              * \brief Define the properties of all the global variational operators involved.
              *
-             * \param[in] input_parameter_data Object which hold the values of all the parameters defined in
-             * the input file.
+             * \copydoc doxygen_hide_input_parameter_data_arg
              */
             void DefineOperators(const InputParameterList& input_parameter_data);
 

Sources/ModelInstances/SurfacicBidomain/SurfacicBidomainVariationalFormulation.hpp

@@ -192,8 +192,7 @@ namespace HappyHeart
             /*!
              * \brief Define the properties of all the global variational operators involved.
              *
-             * \param[in] input_parameter_data Object which hold the values of all the parameters defined in
-             * the input file.
+             * \copydoc doxygen_hide_input_parameter_data_arg
              */
             void DefineOperators(const InputParameterList& input_parameter_data);
             

Sources/Parameters/InitParameter.hpp

@@ -47,8 +47,7 @@ namespace HappyHeart
      * \tparam InputParameterDataT Type of the input parameter file for the considered model instance.
      *
      * \param[in] name Name of the parameter, as it will appear in outputs.
-     * \param[in] input_parameter_data Objects that store the content of the Ops file used for the considered model
-     * instance.
+     * \copydoc doxygen_hide_input_parameter_data_arg
      *
      * \return Parameter considered.
      */