Commit 438bd24c authored by GILLES Sebastien's avatar GILLES Sebastien
Browse files

#9 More Doxygen documentation in Petsc/Wrapper.

parent eb790bc4
......@@ -5632,6 +5632,7 @@
BE2EEA451DB4DB5300AF0D62 /* CopyValues.cpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.cpp; name = CopyValues.cpp; path = FromParameterAtDof/Internal/Local/CopyValues.cpp; sourceTree = "<group>"; };
BE2EEA461DB4DB5300AF0D62 /* CopyValues.hpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.h; name = CopyValues.hpp; path = FromParameterAtDof/Internal/Local/CopyValues.hpp; sourceTree = "<group>"; };
BE2EEA4B1DB4DF9400AF0D62 /* SConscript */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text; path = SConscript; sourceTree = "<group>"; };
BE3047E41DF86D7C00582480 /* Matrix.doxygen */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text; path = Matrix.doxygen; sourceTree = "<group>"; };
BE30D2741DE45FF000B5768B /* demo_input_test_from_vertex_matching_vectorial_P2.lua */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text; path = demo_input_test_from_vertex_matching_vectorial_P2.lua; sourceTree = "<group>"; };
BE30D27B1DE4982300B5768B /* CauchyGreenTensor.cpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.cpp; name = CauchyGreenTensor.cpp; path = Data/CauchyGreenTensor.cpp; sourceTree = "<group>"; };
BE30D27C1DE4982300B5768B /* CauchyGreenTensor.hpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.h; name = CauchyGreenTensor.hpp; path = Data/CauchyGreenTensor.hpp; sourceTree = "<group>"; };
......@@ -12868,6 +12869,7 @@
BEEFEF71196ECCC000C80FF1 /* Matrix */ = {
isa = PBXGroup;
children = (
BE3047E41DF86D7C00582480 /* Matrix.doxygen */,
BEEFEF72196ECCC000C80FF1 /* Matrix.cpp */,
BEEFEF73196ECCC000C80FF1 /* Matrix.hpp */,
BEEFEF74196ECCC000C80FF1 /* Matrix.hxx */,
/*!
* \class doxygen_hide_parallel_matrix_args
*
* \param[in] Nlocal_row Number of rows on the local processor.
* \param[in] Nlocal_column Number of columns on the local processor.
* \param[in] Nglobal_row Number of rows on the global processor.
* \param[in] Nglobal_column Number of columns on the global processor.
*/
......@@ -158,10 +158,7 @@ namespace HappyHeart
/*!
* \brief Create a parallel sparse matrix.
*
* \param[in] Nlocal_row Number of rows on the local processor.
* \param[in] Nlocal_column Number of columns on the local processor.
* \param[in] Nglobal_row Number of rows on the global processor.
* \param[in] Nglobal_column Number of columns on the global processor.
* \copydoc doxygen_hide_parallel_matrix_args
* \param[in] matrix_pattern Pattern of the matrix (number of elements expected on each row_).
* \copydetails doxygen_hide_mpi_param
* \copydoc doxygen_hide_invoking_file_and_line
......
......@@ -385,7 +385,7 @@ namespace HappyHeart
* \param[in] P P in C = P^T * A * P
* \param[out] out C in C = P^T * A * P. The matrix must be not allocated when this function is called.
* \copydetails doxygen_hide_invoking_file_and_line
* \copydoc doxygen_hide_petsc_do_reuse_matrix
* \copydoc doxygen_hide_petsc_do_reuse_matrix_arg
*/
/*!
......
......@@ -64,13 +64,18 @@ namespace HappyHeart
/*!
* \brief Constructor.
*
* \copydoc doxygen_hide_parallel_matrix_args
* \copydetails doxygen_hide_mpi_param
* \param[in] mat_op MatOperation object which specifies which operation is to be redefined for the
* shell matrix. So far only MATOP_MULT has been redefined this way in FSI model.
* \param[in] context Pointer to data needed by the shell matrix routines.
* \copydoc doxygen_hide_invoking_file_and_line
*/
explicit ShellMatrix(const Wrappers::Mpi& mpi,
unsigned int Nlocal_row, unsigned int Nlocal_column,
unsigned int Nglobal_row, unsigned int Nglobal_column,
unsigned int Nlocal_row,
unsigned int Nlocal_column,
unsigned int Nglobal_row,
unsigned int Nglobal_column,
ContextT* context,
MatOperation mat_op,
const char* invoking_file, int invoking_line);
......@@ -110,6 +115,7 @@ namespace HappyHeart
*
* \param[in] mat_op MatOperation object which specifies which operation is to be redefined for the
* shell matrix. So far only MATOP_MULT has been redefined this way in FSI model.
* \copydoc doxygen_hide_invoking_file_and_line
*
* The implementation itself is expected to be given by ContextT::ShellMatrixOperation(). This one must
* respect the prototype expected by Petsc (e.g. int (Mat, Vec, Vec) for MATOP_MULT) and return 0 if
......
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