Commit 02521347 authored by GILLES Sebastien's avatar GILLES Sebastien
Browse files

#9 Add comments in state operator.

parent c7f05f30
......@@ -74,15 +74,25 @@ namespace HappyHeart
/// \name Special members.
///@{
/*!
* \class doxygen_hide_state_operator_contructor_arg
*
* \param[in] numbering_subset \a NumberingSubset upon which the boundary conditions are defined.
* \param[out] target_vector_pattern Vector which structure is the one expected for the state. The target
* vector of \a ToState() is expected to respect the pattern (in most of the case you should probably give
* here the vector you will use later with \a ToState(). Currently this vector does not include ghosts.
*
* \internal Comment was added much after class implementation and there is no case in which it is applied;
* it is likely interface could be slightly better here.
*/
/*!
* \brief Constructor when complete vector is defined over the whole \a god_of_dof.
*
* \copydoc doxygen_hide_state_operator_contructor_arg
* \param[in] god_of_dof God of dof that includes the vector which state will be required. This
* object is also the one aware of which dofs are bound to an essential boundary condition.
* \param[out] target_vector_pattern Vector which structure is the one expected for the state. The target
* vector of \a ToState() is expected to respect the pattern (in most of the case you should probably give
* here the vector you will use later with \a ToState(). Currently this vector does not include ghosts.
*/
explicit State(const GodOfDof& god_of_dof,
const NumberingSubset& numbering_subset,
......@@ -95,9 +105,7 @@ namespace HappyHeart
* observation and model are defined on the same mesh).
*
* \param[in] felt_space Finite element space to which the vector which state are required must belong to.
* \param[out] target_vector_pattern Vector which structure is the one expected for the state. The target
* vector of \a ToState() is expected to respect the pattern (in most of the case you should probably give
* here the vector you will use later with \a ToState(). Currently this vector does not include ghosts.
* \copydoc doxygen_hide_state_operator_contructor_arg
*/
explicit State(FEltSpace& felt_space,
const NumberingSubset& numbering_subset,
......@@ -155,9 +163,7 @@ namespace HappyHeart
* \param[in] god_of_dof God of dof that includes the vector which state will be required. This
* object is also the one aware of which dofs are bound to an essential boundary condition.
* \param[in] processor_wise_dof_list List of processor-wise dofs in the space considered (ghost excluded).
* \param[out] target_vector_pattern Vector which structure is the one expected for the state. The target
* vector of \a ToState() is expected to respect the pattern (in most of the case you should probably give
* here the vector you will use later with \a ToState().
* \copydoc doxygen_hide_state_operator_contructor_arg
*
*/
void Construct(const GodOfDof& god_of_dof,
......
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