From f6becb9f1a793780a4776585ef36efc04021a5f3 Mon Sep 17 00:00:00 2001 From: ndjinga Date: Wed, 20 Apr 2011 14:30:40 +0000 Subject: [PATCH] Update of the interpolation tools documentation --- doc/doxygen/interpkernel.dox | 10 +++++----- doc/doxygen/medmem.dox | 6 +++--- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/doc/doxygen/interpkernel.dox b/doc/doxygen/interpkernel.dox index ed67e43d1..6b17341a2 100644 --- a/doc/doxygen/interpkernel.dox +++ b/doc/doxygen/interpkernel.dox @@ -202,14 +202,14 @@ As already said, the matrix returned by interpolator is typically a sparse matri Note that \c std::vector\c < \c std::map > is a candidate for \c MatrixType. -\section InterpKerGenUsage Usage of interpolation tools. +\section InterpKerGenUsage Usage of interpolation tools: the REMAPPER classes. \subsection InterpKerHighLevUsage high-level usage -The simplest way of using the interpolation tools is in sequential mode to use REMAPPER classes. These classes fulfill \c HXX2SALOME rules and may be used -in coupling graphs. Two sequential REMAPPERS exist, \c ParaMEDMEM::MEDCouplingRemapper and \c MEDMEM::MEDMEM_Remapper. These classes are strongly linked to their corresponding data structure, respectively \c MEDCoupling and \c MEDMEM. +The simplest way of using the interpolation tools is in sequential mode to use the REMAPPER classes. These classes fulfill \c HXX2SALOME rules and may be used +in coupling graphs. Two sequential REMAPPERS exist, \c ParaMEDMEM::MEDCouplingRemapper and \ref medmemremapper . These classes are strongly linked to their corresponding data structure, respectively \ref medcoupling and \ref MEDMEM. -- If you intend to use MEDCoupling data struture, ParaMEDMEM::MEDCouplingRemapper class should be used : +- If you intend to use \ref MEDCoupling data struture, ParaMEDMEM::MEDCouplingRemapper class should be used : \code ... @@ -231,7 +231,7 @@ sourceField->decrRef(); med_target_mesh->decrRef(); \endcode -- If you intend to use MEDMEM data structure, Remapper class should be used : +- If you intend to use \ref MEDMEM data structure, \c medmemremapper class should be used : \code ... diff --git a/doc/doxygen/medmem.dox b/doc/doxygen/medmem.dox index 81f06af1a..9fb6792ce 100644 --- a/doc/doxygen/medmem.dox +++ b/doc/doxygen/medmem.dox @@ -231,13 +231,13 @@ describe the coupling between two parallel codes. The classes that make up the API of the library are : - communication interface : \ref comm_interface, - definition of processor groups : \ref processor_group, -- Data Exchange Channel (aka DEC, abstract class) : \ref dec, and its implementations : - - \ref interpkerneldec for a \ref InterpKerRemapGlobal based on intersecting elems volume computation, +- Data Exchange Channel \ref dec, and its implementations : + - \ref interpkerneldec for a \ref InterpKerRemapGlobal based on intersecting elements volume computation, - \ref noncoincidentdec for a non-conservative interpolation based on element localization, - \ref structuredcoincidentdec for remapping coincident meshes on a one-to-one basis. This class applies to structured topologies. - \ref explicitcoincidentdec for remapping coincident meshes on a one-to-one basis. This class applies to unstructured topologies, - \ref overlapdec based on intersecting elems volume - computation with source and target meshes are on same process id + computation when source and target meshes are on same process id */ -- 2.39.2