From 7d29d305b7ad304ea3e274da604197d22fbb972d Mon Sep 17 00:00:00 2001 From: vbd Date: Fri, 22 Feb 2008 09:51:23 +0000 Subject: [PATCH] adding doc files --- doc/doxygen/Doxyfile_med_user.in | 194 +++++++++++++++++++++++++++++++ doc/doxygen/Makefile.am | 28 +++++ doc/doxygen/field.dox | 10 +- doc/doxygen/gauss.dox | 51 ++++++++ doc/doxygen/main.dox | 14 +-- 5 files changed, 283 insertions(+), 14 deletions(-) create mode 100644 doc/doxygen/Doxyfile_med_user.in create mode 100644 doc/doxygen/Makefile.am create mode 100644 doc/doxygen/gauss.dox diff --git a/doc/doxygen/Doxyfile_med_user.in b/doc/doxygen/Doxyfile_med_user.in new file mode 100644 index 000000000..52b5f3625 --- /dev/null +++ b/doc/doxygen/Doxyfile_med_user.in @@ -0,0 +1,194 @@ +# Doxyfile 0.1 + +#--------------------------------------------------------------------------- +# General configuration options +#--------------------------------------------------------------------------- +PROJECT_NAME = "Med Memory Users' Guide" +PROJECT_NUMBER = @VERSION@ +OUTPUT_DIRECTORY = doc_ref_user +OUTPUT_LANGUAGE = English +EXTRACT_ALL = YES +EXTRACT_PRIVATE = NO +EXTRACT_STATIC = NO +HIDE_UNDOC_MEMBERS = YES +HIDE_UNDOC_CLASSES = YES +BRIEF_MEMBER_DESC = NO +REPEAT_BRIEF = YES +ALWAYS_DETAILED_SEC = NO +FULL_PATH_NAMES = NO +STRIP_FROM_PATH = +INTERNAL_DOCS = NO +STRIP_CODE_COMMENTS = YES +CASE_SENSE_NAMES = YES +SHORT_NAMES = NO +HIDE_SCOPE_NAMES = NO +VERBATIM_HEADERS = NO +SHOW_INCLUDE_FILES = NO +JAVADOC_AUTOBRIEF = NO +INHERIT_DOCS = YES +INLINE_INFO = NO +SORT_MEMBER_DOCS = NO +DISTRIBUTE_GROUP_DOC = NO +TAB_SIZE = 8 +GENERATE_TODOLIST = YES +GENERATE_TESTLIST = YES +GENERATE_BUGLIST = YES +ALIASES = +ENABLED_SECTIONS = user MEDMEM_ug +MAX_INITIALIZER_LINES = 30 +OPTIMIZE_OUTPUT_FOR_C = NO +SHOW_USED_FILES = NO +#--------------------------------------------------------------------------- +# configuration options related to warning and progress messages +#--------------------------------------------------------------------------- +QUIET = NO +WARNINGS = YES +WARN_IF_UNDOCUMENTED = YES +WARN_FORMAT = "$file:$line: $text" +WARN_LOGFILE = log_user +#--------------------------------------------------------------------------- +# configuration options related to the input files +#--------------------------------------------------------------------------- +INPUT = @top_srcdir@/doc/doxygen \ + @top_srcdir@/src/ParaMEDMEM \ + @top_srcdir@/src/INTERP_KERNEL \ + @top_srcdir@/src/MEDMEM + +FILE_PATTERNS = MEDMEM_Mesh.* \ + MEDMEM_Grid.* \ + MEDMEM_Meshing.* \ + MEDMEM_Support.* \ + MEDMEM_Field.* \ + MEDMEM_Med.* \ + IntersectionDEC.* \ + DEC.* \ + MPIProcessorGroup.* \ + StructuredCoincidentDEC.* \ + ExplicitCoincidentDEC.* \ + NonCoincidentDEC.* \ + CommInterface.* \ + Interpolation2D.* \ + Interpolation3D.* \ + Interpolation3DSurf.* \ + InterpolationMatrix.* \ + ParaFIELD.* \ + *.dox +RECURSIVE = NO +EXCLUDE = CVS +EXCLUDE_PATTERNS = *~ +EXAMPLE_PATH = @top_srcdir@/src/ParaMEDMEM/ \ + @top_srcdir@/doc/MEDMEM +EXAMPLE_PATTERNS = *.cxx *.py +EXAMPLE_RECURSIVE = NO +IMAGE_PATH = @top_srcdir@/doc/doxygen/figures +INPUT_FILTER = +FILTER_SOURCE_FILES = NO +#--------------------------------------------------------------------------- +# configuration options related to source browsing +#--------------------------------------------------------------------------- +SOURCE_BROWSER = NO +INLINE_SOURCES = NO +REFERENCED_BY_RELATION = YES +REFERENCES_RELATION = YES +#--------------------------------------------------------------------------- +# configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- +ALPHABETICAL_INDEX = YES +COLS_IN_ALPHA_INDEX = 5 +IGNORE_PREFIX = +#--------------------------------------------------------------------------- +# configuration options related to the HTML output +#--------------------------------------------------------------------------- +GENERATE_HTML = YES +HTML_OUTPUT = html +HTML_HEADER = +HTML_FOOTER = +HTML_STYLESHEET = +HTML_ALIGN_MEMBERS = YES +GENERATE_HTMLHELP = YES +GENERATE_CHI = YES +BINARY_TOC = NO +TOC_EXPAND = YES +DISABLE_INDEX = NO +ENUM_VALUES_PER_LINE = 4 +GENERATE_TREEVIEW = YES +TREEVIEW_WIDTH = 250 +#--------------------------------------------------------------------------- +# configuration options related to the LaTeX output +#--------------------------------------------------------------------------- +GENERATE_LATEX = YES +LATEX_OUTPUT = latex +COMPACT_LATEX = YES +PAPER_TYPE = a4wide +EXTRA_PACKAGES = +LATEX_HEADER = +PDF_HYPERLINKS = NO +USE_PDFLATEX = NO +LATEX_BATCHMODE = NO +#--------------------------------------------------------------------------- +# configuration options related to the RTF output +#--------------------------------------------------------------------------- +GENERATE_RTF = NO +RTF_OUTPUT = rtf +COMPACT_RTF = NO +RTF_HYPERLINKS = NO +RTF_STYLESHEET_FILE = +RTF_EXTENSIONS_FILE = +#--------------------------------------------------------------------------- +# configuration options related to the man page output +#--------------------------------------------------------------------------- +GENERATE_MAN = NO +MAN_OUTPUT = man +MAN_EXTENSION = .3 +MAN_LINKS = NO +#--------------------------------------------------------------------------- +# configuration options related to the XML output +#--------------------------------------------------------------------------- +GENERATE_XML = NO +#--------------------------------------------------------------------------- +# Configuration options related to the preprocessor +#--------------------------------------------------------------------------- +ENABLE_PREPROCESSING = YES +MACRO_EXPANSION = NO +EXPAND_ONLY_PREDEF = NO +SEARCH_INCLUDES = YES +INCLUDE_PATH = +INCLUDE_FILE_PATTERNS = +PREDEFINED = +EXPAND_AS_DEFINED = +SKIP_FUNCTION_MACROS = YES +#--------------------------------------------------------------------------- +# Configuration::addtions related to external references +#--------------------------------------------------------------------------- +TAGFILES = +GENERATE_TAGFILE = +ALLEXTERNALS = NO +PERL_PATH = /usr/bin/perl +#--------------------------------------------------------------------------- +# Configuration options related to the dot tool +#--------------------------------------------------------------------------- +CLASS_DIAGRAMS = YES +HAVE_DOT = YES +CLASS_GRAPH = YES +COLLABORATION_GRAPH = YES +TEMPLATE_RELATIONS = YES +HIDE_UNDOC_RELATIONS = YES +INCLUDE_GRAPH = YES +INCLUDED_BY_GRAPH = YES +GRAPHICAL_HIERARCHY = YES +DOT_PATH = +DOTFILE_DIRS = +MAX_DOT_GRAPH_WIDTH = 1024 +MAX_DOT_GRAPH_HEIGHT = 1024 +GENERATE_LEGEND = YES +DOT_CLEANUP = YES +#--------------------------------------------------------------------------- +# Configuration::addtions related to the search engine +#--------------------------------------------------------------------------- +SEARCHENGINE = NO +CGI_NAME = search.cgi +CGI_URL = +DOC_URL = +DOC_ABSPATH = +BIN_ABSPATH = /usr/local/bin/ +EXT_DOC_PATHS = diff --git a/doc/doxygen/Makefile.am b/doc/doxygen/Makefile.am new file mode 100644 index 000000000..76f8b3de6 --- /dev/null +++ b/doc/doxygen/Makefile.am @@ -0,0 +1,28 @@ +# MED MEDMEM : MED files in memory +# +# Copyright (C) 2003 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN, +# CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS +# +# This library is free software; you can redistribute it and/or +# modify it under the terms of the GNU Lesser General Public +# License as published by the Free Software Foundation; either +# version 2.1 of the License. +# +# This library is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# Lesser General Public License for more details. +# +# You should have received a copy of the GNU Lesser General Public +# License along with this library; if not, write to the Free Software +# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA +# +# See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com +# + +include $(top_srcdir)/adm_local/unix/make_common_starter.am + +doxygen : + doxygen Doxyfile_med_user + +EXTRA_DIST += doc_ref_user \ No newline at end of file diff --git a/doc/doxygen/field.dox b/doc/doxygen/field.dox index 318e88a62..db5f25746 100644 --- a/doc/doxygen/field.dox +++ b/doc/doxygen/field.dox @@ -64,13 +64,9 @@ The following sections describe the FIELD methods : - constructors : \ref FIELD_constructors - access methods : \ref FIELD_getset - creation methods : \ref FIELD_value +- I/O methods :\ref FIELD_io - - -%\input{./dox/latex/group__FIELD__gauss.tex - -\input{./dox/latex/group__FIELD__io.tex} -\subsubsection{Example} +\subsubsection field_io_example Example for I/O routines This program gives an example of creation of a file containing a mesh and fields. This program is a tool that reads a mesh in an input file, creates a field @@ -85,7 +81,7 @@ mesh name (as obtained by {\tt getName()}). \verbatiminput{FIELDwrite.cxx} \normalsize -\subsection{Example}\label{FIELDgeneral.cxx} +\subsection FIELD_example Example The following example reviews most of the notions seen in this section. \small diff --git a/doc/doxygen/gauss.dox b/doc/doxygen/gauss.dox new file mode 100644 index 000000000..43eb88364 --- /dev/null +++ b/doc/doxygen/gauss.dox @@ -0,0 +1,51 @@ +\defgroup gauss Gauss points + +In MED, it is possible to declare a Gauss model that +describes the location of Gauss points in a reference cell. +This Gauss model definition is contained in the +\a GAUSS_LOCALIZATION class. A \a GAUSS_LOCALIZATION object +is associated to a field and to a type. + +It is not permitted to define a Gauss model in a polygonal +or polyhedric element. + +The Gauss model can be : +- loaded from a MED file, +- written to a MED file, +- used to define a FIELD with multiple localizations per element. + +\section gauss_constructors Constructing a Gauss Model +A Gauss model can be constructed with the following constructor : +\param locName defines a name associated with the gauss model +\param typeGeo names the type to which the Gauss model is assocaited +\param nGauss defines the number of Gauss points +\param cooRef defines an array giving the coordinates of the nodes of the reference element (dimension : spaceDimension * number of nodes for type \a typeGeo) +\param cooGauss defines an array giving the coordinates of the nodes of the Gauss points (dimension : spaceDimension * \a nGauss +) +\param wg weights associated with each Gauss point (dimension : \a nGauss) + +Example : in 2D, a Gauss model definition for a triangle +would be written as : + +\code +string locname("gauss model"); +double cooRef[6] ={0.0, 0.0, 1.0, 0.0, 0.0, 1.0}; +double cooGauss[6]={0.2, 0.2, 0.8, 0.1, 0.1, 0.8}; +double wg[3]={0.3334, 0.3334, 0.3334}; +GAUSS_LOCALIZATION model(locname, + MED_EN::MED_TRIA3, + 3, + cooRef, + cooGauss, + wg); +\endcode + +*/ + +GAUSS_LOCALIZATION(const string & locName, + const MED_EN::medGeometryElement typeGeo, + const int nGauss, + const double * const cooRef, + const double * const cooGauss, + const double * const wg) throw (MEDEXCEPTION); + diff --git a/doc/doxygen/main.dox b/doc/doxygen/main.dox index 5e802b629..e17b68b68 100644 --- a/doc/doxygen/main.dox +++ b/doc/doxygen/main.dox @@ -5,17 +5,17 @@ \image latex MED_small.eps \section intro Introduction -This document constitutes the user guide of the MEDMEM library and of its related tools. +This document constitutes the user guide of the %MEDMEM library and of its related tools. \section install Installation -The install procedure of the MEDMEM library can handle a variety of configurations +The install procedure of the %MEDMEM library can handle a variety of configurations to suit the needs of its user. Instructions for configuring and installing the library can be found in \ref medmem_install. \section outline Outline -This user guide contains three different chapters that covers the code MEDMEM library, the ParaMEDMEM library and the MEDSPLITTER tool: -- Chapter \ref medmem covers the MEDMEM core library, i.e. the implementation of meshes, supports and fields and the associated drivers (for MED-file, VTK, GIBI). -- Chapter \ref paramedmem describes its MPI implementation, which is called ParaMEDMEM. -- Chapter \ref medsplitter describes the implementation of the medsplitter tool that can be used to partition MED files over a number of subdomains. +This user guide contains three different chapters that covers the core %MEDMEM library, the %ParaMEDMEM library and the %MEDSPLITTER tool: +- Chapter \ref medmem covers the %MEDMEM core library, i.e. the implementation of meshes, supports and fields and the associated drivers (for MED-file, VTK, GIBI). +- Chapter \ref paramedmem describes its MPI implementation, which is called %ParaMEDMEM. +- Chapter \ref medsplitter describes the implementation of the medsplitter tool that can be used to partition %MED files over a number of subdomains. */ @@ -25,7 +25,7 @@ This user guide contains three different chapters that covers the code MEDMEM li \section medmem_introduction Introduction \subsection medmem_rationale Rationale for Med Memory -The Med data exchange model (DEM in English) is the format used in the Salome platform for communicating data between different components. It manipulates objects that describe the meshes underlying scientific computations and the value fields lying on these meshes. This data exchange can be achieved either through files using the Med-file formalism or directly through memory with the Med Memory (\c MEDMEM) library. +The Med data exchange model (DEM in English) is the format used in the Salome platform for communicating data between different components. It manipulates objects that describe the meshes underlying scientific computations and the value fields lying on these meshes. This data exchange can be achieved either through files using the Med-file formalism or directly through memory with the Med Memory (\c %MEDMEM) library. The Med libraries are oganized in multiple layers: - The MED file layer : C and Fortran API to implement mesh and field persistency. -- 2.39.2