From 0c14de99197c1a1e38832d472638f282cffaf2a3 Mon Sep 17 00:00:00 2001 From: Gbkng Date: Mon, 8 Apr 2024 16:15:39 +0200 Subject: [PATCH] fix: remove special chars in text, typo and trailing whitespaces --- .../doxygen/doxfiles/appendix/glossary.dox | 8 +++---- .../doxygen/doxfiles/appendix/install.dox | 2 +- doc/developer/doxygen/doxfiles/faq.dox | 24 +++++++++---------- doc/developer/doxygen/doxfiles/index.dox | 5 +--- 4 files changed, 18 insertions(+), 21 deletions(-) diff --git a/doc/developer/doxygen/doxfiles/appendix/glossary.dox b/doc/developer/doxygen/doxfiles/appendix/glossary.dox index a4b844b25..2322e152c 100644 --- a/doc/developer/doxygen/doxfiles/appendix/glossary.dox +++ b/doc/developer/doxygen/doxfiles/appendix/glossary.dox @@ -5,9 +5,9 @@ - The \b dimension \b of \b a \b mesh is characterized by two parameters: the size of the space wherein the mesh is immersed, and the (maximum) size of the mesh cells. Examples: 3D surface mesh (3D space, 2D cells), 3D mesh (3D space, 3D cells), curved 2D mesh (2D space, 1D cells)... -- \b Field: physical quantity whose value varies in space and time. Represented by a result vector V obtained from one or more tables of values ​​A, at any point of space covered by a mesh and in time defined by its temporal resolution. The size of V is called the number of \b components (equal to the number of components of A). +- \b Field: physical quantity whose value varies in space and time. Represented by a result vector V obtained from one or more tables of values A, at any point of space covered by a mesh and in time defined by its temporal resolution. The size of V is called the number of \b components (equal to the number of components of A). A P1 field is a field where values are stored at node level, a P0 field is a field where values are stored -at cell level. +at cell level. - \b Intensive \b field: represents intensive physical data (i.e. which do not depend on the amount of material). Examples: density, power density, temperature, pressure. - \b Extensive \b field: represents extensive physical data (i.e. proportional to the size of the physical system represented). @@ -28,8 +28,8 @@ Examples: mass, volume, time, power. - \b Conservativity: preservation of conservation laws governing physical quantities during their discretization or their interpolation. - \b Projection: modification (by interpolation) of the entity on which a field is defined. The projection is called \b conservative if the interpolation uses intersection detection. The projection is said \b not \b conservative if the interpolation localizes a cloud of points in a mesh. - The \b Gauss \b integration \b points are the geometrical points where the numerical integration of a given quantity is performed. Precise location of these nodes and a sufficient number (related to the approximation order of the integration term) allow for an exact integration in the case of polynomial functions integration. -- \b Kriging: a linear estimation method guaranteeing minimum variance. The estimate at a given point P is obtained locally from the point values ​​on a neighbourhood of P. +- \b Kriging: a linear estimation method guaranteeing minimum variance. The estimate at a given point P is obtained locally from the point values on a neighborhood of P. - \b Code \b coupling: run of two numerical codes (or two instances of the same code) in such a way that information -is passed from one instance to the other. +is passed from one instance to the other. */ diff --git a/doc/developer/doxygen/doxfiles/appendix/install.dox b/doc/developer/doxygen/doxfiles/appendix/install.dox index eb142e0f9..d73c46c9c 100644 --- a/doc/developer/doxygen/doxfiles/appendix/install.dox +++ b/doc/developer/doxygen/doxfiles/appendix/install.dox @@ -7,7 +7,7 @@ installing the module can be found here. Partitioning and parallel functionalities are optional. Assume that the library sources are located in \a MEDCOUPLING_SRC directory. Build and install directories are MEDCOUPLING_BUILD and MEDCOUPLING_INSTALL, respectively. -The first step consists in preparing the CMake build precedure : +The first step consists in preparing the CMake build procedure : \verbatim mkdir cd diff --git a/doc/developer/doxygen/doxfiles/faq.dox b/doc/developer/doxygen/doxfiles/faq.dox index 7bec3a938..6bd7be795 100644 --- a/doc/developer/doxygen/doxfiles/faq.dox +++ b/doc/developer/doxygen/doxfiles/faq.dox @@ -15,7 +15,7 @@ Python API is almost 100% identical to the C++ one, with the \ref python-api "ru -# \ref f-p0p1 -# \ref f-number -# \ref f-struct-ordering - + \ref faq-python -# \ref f-hellow -# \ref f-pyimport @@ -46,7 +46,7 @@ Take a look at \ref terminology Take a look at \ref library \subsubsection f-visu How can I visualize a mesh and/or a field? -Use the PARAVIS module of SALOME to visualize your MED file. The following dedicated filters have been +Use the PARAVIS module of SALOME to visualize your MED file. The following dedicated filters have been written specifically for MED files: Extract group, Extract cell types, ELNO Mesh, ELNO Points, ELNO Surface. \subsubsection f-p0p1 What does a P0- (or P1-) field mean? @@ -59,13 +59,13 @@ Take a look at \ref numbering When converting a structured mesh to unstructured one, or when storing a field onto a structured mesh, the numbering convention detailed in \ref MEDCoupling::MEDCouplingStructuredMesh::buildUnstructured() is used. -\subsection faq-python MEDCoupling scripts in Python +\subsection faq-python MEDCoupling scripts in Python \subsubsection f-hellow "Can you show me a simple example to get me started" TODO \subsubsection f-pyimport "When trying to execute my Python script I have 'ImportError: No module named MEDCoupling'" -Check that the environment variables PYTHONPATH and LD_LIBRARY_PATH (PATH under Windows) are correctly set. +Check that the environment variables PYTHONPATH and LD_LIBRARY_PATH (PATH under Windows) are correctly set. If you have a full SALOME installation, use the 'shell' command that will automatically set up everything as it should be: \code{.sh} @@ -90,7 +90,7 @@ For starter, take a look at the \ref MEDLoaderBasicAPIPage "basic MEDLoader API" \subsubsection f-coher "How to control the validity of my mesh" Use the methods \ref MEDCoupling::MEDCouplingUMesh::checkConsistencyLight() "MEDCouplingUMesh::checkConsistencyLight()" or -\ref MEDCoupling::MEDCouplingUMesh::checkConsistency() "MEDCouplingUMesh::checkConsistency()" +\ref MEDCoupling::MEDCouplingUMesh::checkConsistency() "MEDCouplingUMesh::checkConsistency()" \subsubsection f-groups "How can I read/write groups on a mesh" Take a look at \ref AdvMEDLoaderAPIMeshReading and \ref AdvMEDLoaderAPIMeshWriting. @@ -100,11 +100,11 @@ Use the method \ref MEDCoupling::MEDCouplingCMesh::buildUnstructured() "MEDCoup \subsection faq-interp Projection, interpolation, remapping \subsubsection f-proj How to project a field from one mesh to the other -This the job of the interpolation algorithms in the MED library. For starters, take a look at the -\ref interpolation "general introduction on interpolation". Also +This the job of the interpolation algorithms in the MED library. For starters, take a look at the +\ref interpolation "general introduction on interpolation". Also \ref cpp_mcfield_remapper_highlevel "this simple example" gives a good first illustration. -Finally, if you are intereseted in parallel projection (C++ only!), you should take a -look at the \ref para-dec "DEC". +Finally, if you are intersected in parallel projection (C++ only!), you should take a +look at the \ref para-dec "DEC". \subsubsection f-proj-formula Which formula are used in the field projection algorithms The documentation for non \ref glossary "P0 field" (i.e. non \ref glossary "cell-based fields") is still an @@ -121,10 +121,10 @@ Yes. Please: Re-compile in debug mode (with \c CMAKE_BUILD_TYPE=Debug), and use either valgrind or gdb to spot the place where the segfault happens. The most common source of mistake is some memory mis-allocation and/or deallocation. -With this respect using the auto pointer class +With this respect using the auto pointer class \ref MEDCoupling::MCAuto "MCAuto" -can be of great help. - +can be of great help. + \n \n \n diff --git a/doc/developer/doxygen/doxfiles/index.dox b/doc/developer/doxygen/doxfiles/index.dox index 2f690680d..24d88789b 100644 --- a/doc/developer/doxygen/doxfiles/index.dox +++ b/doc/developer/doxygen/doxfiles/index.dox @@ -5,7 +5,7 @@ The MEDCoupling tool gathers several powerful functionalities around the input and output data of simulation codes (meshes and fields mainly). -\image html projectionHQ_600.png "Example of a field interpolation between two 3D surfacic meshes" +\image html projectionHQ_600.png "Example of a field interpolation between two 3D surface meshes" The most common usage is to write dedicated code (C++ or Python) linking to the library. However a graphical user interface is also available; for this please refer to the MED module documentation. @@ -52,6 +52,3 @@ This documentation is organized as follows: - \ref MEDCoupling "MEDCoupling, MEDLoader (and other parallel classes) API documentation" */ - - - -- 2.39.2