From f972af7ef7eba1f823ca54373434efb88ac96e41 Mon Sep 17 00:00:00 2001 From: abn Date: Tue, 16 Mar 2021 21:34:42 +0100 Subject: [PATCH] Documentation ICoCo. --- doc/developer/doxygen/Doxyfile_med_dev.in | 3 ++- .../doxygen/doxfiles/appendix/appendix.dox | 1 + .../doxfiles/appendix/porting_icoco.dox | 18 ++++++++++++++++++ .../doxygen/doxfiles/reference/misc/icoco.dox | 18 +++++++++++++++--- .../doxygen/doxfiles/reference/reference.dox | 1 + 5 files changed, 37 insertions(+), 4 deletions(-) create mode 100644 doc/developer/doxygen/doxfiles/appendix/porting_icoco.dox diff --git a/doc/developer/doxygen/Doxyfile_med_dev.in b/doc/developer/doxygen/Doxyfile_med_dev.in index f5eda6db5..6a8da6547 100644 --- a/doc/developer/doxygen/Doxyfile_med_dev.in +++ b/doc/developer/doxygen/Doxyfile_med_dev.in @@ -75,6 +75,7 @@ INPUT = @CMAKE_CURRENT_SOURCE_DIR@/doxfiles/index.dox \ @PROJECT_SOURCE_DIR@/src/INTERP_KERNEL/Bases \ @PROJECT_SOURCE_DIR@/src/INTERP_KERNEL/Geometric2D \ @PROJECT_SOURCE_DIR@/src/MEDCoupling \ + @PROJECT_SOURCE_DIR@/src/ICoCo \ @PROJECT_SOURCE_DIR@/src/MEDLoader FILE_PATTERNS = InterpKernelDEC.*xx \ @@ -151,7 +152,7 @@ FILE_PATTERNS = InterpKernelDEC.*xx \ RECURSIVE = YES EXCLUDE = CVS EXCLUDE_PATTERNS = *~ -EXCLUDE_SYMBOLS = ICoCo +EXCLUDE_SYMBOLS = EXAMPLE_PATH = @PROJECT_SOURCE_DIR@/src/ParaMEDMEM \ @PROJECT_SOURCE_DIR@/src/MEDCoupling/Test \ @PROJECT_SOURCE_DIR@/src/MEDCoupling_Swig \ diff --git a/doc/developer/doxygen/doxfiles/appendix/appendix.dox b/doc/developer/doxygen/doxfiles/appendix/appendix.dox index 333eed612..f8aece8db 100644 --- a/doc/developer/doxygen/doxfiles/appendix/appendix.dox +++ b/doc/developer/doxygen/doxfiles/appendix/appendix.dox @@ -5,6 +5,7 @@ Some useful complementary resources: - \subpage porting +- \subpage porting_icoco - \subpage glossary - \subpage med-file - \subpage install diff --git a/doc/developer/doxygen/doxfiles/appendix/porting_icoco.dox b/doc/developer/doxygen/doxfiles/appendix/porting_icoco.dox new file mode 100644 index 000000000..6b852062e --- /dev/null +++ b/doc/developer/doxygen/doxfiles/appendix/porting_icoco.dox @@ -0,0 +1,18 @@ +/*! + +\page porting_icoco Porting ICoCo code/scripts from version 9.6 to version 9.7 (and above) + +From version 9.7 of MEDCoupling +- the C++ class ICoCo::MEDField has been renamed into +ICoCo::MEDDoubleField. This is to make a clear distinction with the newly created ICoCo::MEDIntField. +- the method ICoCo::MEDDoubleField::getField() has been renamed into ICoCo::MEDDoubleField::getMCField() and +a new method ICoCo::MEDDoubleField::setMCField() has been added. + +In Python, we keep the namespace in front of the name, and hence the two classes +are respectively called ICoCoMEDDoubleField and ICoCoMEDIntField. + +The APIs of the various \ref para-dec have also been updated accordingly. + +See also the page \ref icoco. +*/ + diff --git a/doc/developer/doxygen/doxfiles/reference/misc/icoco.dox b/doc/developer/doxygen/doxfiles/reference/misc/icoco.dox index b48ec73a9..f10292696 100644 --- a/doc/developer/doxygen/doxfiles/reference/misc/icoco.dox +++ b/doc/developer/doxygen/doxfiles/reference/misc/icoco.dox @@ -2,10 +2,22 @@ \page icoco The ICoCo API -ICoCo stands for Interface for COde COupling. +ICoCo stands for Interface for COde COupling. -It is a pure abstract API defining a standard way for two physical codes to exchange information between them. +It is a pure abstract API defining a standard way for two physical codes to exchange +information between them. -TODO: complete this section. +The full definition of this interface is held in the opensource TRUST plaform repository +(sub-folder Outils/src/LIBICOCOAPI) that can be found here: +https://sourceforge.net/projects/trust-platform +The MEDCoupling library provides the implementation of the ICoCo::MEDDoubleField and +ICoCo::MEDIntField classes used in some of the field exchange methods. We also provide +the sequential and parallel interpolation tools which are often needed in such coupling (see +\ref interpolation and \ref para-dec respectively) + +WARNING: currently, no implementation of the ICoCo::MEDStringField object is provided yet, you are welcome +to propose one if you need it. + +Note: some class names have been changed in version 9.7, take a look at \ref porting_icoco */ diff --git a/doc/developer/doxygen/doxfiles/reference/reference.dox b/doc/developer/doxygen/doxfiles/reference/reference.dox index d6419583d..6547673b8 100644 --- a/doc/developer/doxygen/doxfiles/reference/reference.dox +++ b/doc/developer/doxygen/doxfiles/reference/reference.dox @@ -18,6 +18,7 @@ You can also take a look at the numerous \ref examples "code examples" provided - \subpage interpolation - \subpage cpp - \subpage distrib +- \subpage icoco - \subpage misc */ -- 2.39.2