From c21650f4ecb858e6cac962f422dcad33fc815db1 Mon Sep 17 00:00:00 2001 From: abn Date: Fri, 9 Oct 2015 16:44:30 +0200 Subject: [PATCH] Re instantiating sub page medcoupling --- .../doxfiles/reference/medcoupling.dox | 39 +++++++++++++++++++ 1 file changed, 39 insertions(+) create mode 100644 doc2/user/doxygen/doxfiles/reference/medcoupling.dox diff --git a/doc2/user/doxygen/doxfiles/reference/medcoupling.dox b/doc2/user/doxygen/doxfiles/reference/medcoupling.dox new file mode 100644 index 000000000..2e64127ab --- /dev/null +++ b/doc2/user/doxygen/doxfiles/reference/medcoupling.dox @@ -0,0 +1,39 @@ +/*! +\page medcoupling Core data structures (MEDCoupling) + +

Overview

+ +The MEDCoupling library gather the core structures used everywhere in the MED world. + +- \subpage arrays +- \subpage numbering +- \subpage meshes +- \subpage fields + +

Design philosophy

+ +The structures described above (arrays, meshes and fields), with the algorithms associated to it +form the core of the MEDCoupling library (\b libmedcoupling.so or \b medcoupling.dll). +It is fully written in C++ and wrapped in Python. + +The MEDCoupling C++ library implements a data structure which is the result of the following tradeoff: +- compliant with \ref glossary "code coupling": + - fields data structure containing enough information to perform a well defined interpolation + - data structure exchangeable through processes, as well in \ref parallel "parallel" (SPMD paradigm - + \ref library "sometimes called ParaMEDMEM"), as in a \ref distrib-corba "distributed paradigm" (using CORBA). +- minimize as much as possible the number of external software prerequisites needed to use it (the core of the +library, MEDCoupling, can be built as a standalone tool). +- light and agile enough to: + - maximize the amount of possible algorithms being applied on it + - ease the implementation of other projects using MEDCoupling as a prerequisite. +- large enough to be used for MED file I/O (thanks to the \ref medloader "MEDLoader" part). +- compliant with VTK visualization data structures +- integrate HPC constraints (compact structures, limitation of copies and launching of CPU consuming algorithms only when absolutely needed ). +- compliant with the \ref icoco "ICoCo API" + +The MEDCoupling also implements a set of algorithms linked to this data structure. The +\ref functionalities "functionalities" section gives an insight of the avalaible algorithm. + + + +*/ \ No newline at end of file -- 2.39.2