From: eap Date: Tue, 12 Mar 2013 13:58:47 +0000 (+0000) Subject: 0021856: [CEA 663] Documenting API of MEDCoupling and MEDLoader X-Git-Tag: V6_main_FINAL~299 X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=22f63b262a4d6b719846d45c12b72b5b94b49b4f;p=tools%2Fmedcoupling.git 0021856: [CEA 663] Documenting API of MEDCoupling and MEDLoader Fix a typo: usefull -> useful --- diff --git a/src/MEDCoupling/MEDCouplingFieldDiscretization.cxx b/src/MEDCoupling/MEDCouplingFieldDiscretization.cxx index 1ba44ea5d..1c0c1ace6 100644 --- a/src/MEDCoupling/MEDCouplingFieldDiscretization.cxx +++ b/src/MEDCoupling/MEDCouplingFieldDiscretization.cxx @@ -1448,7 +1448,7 @@ DataArrayInt *MEDCouplingFieldDiscretizationGauss::buildNbOfGaussPointPerCellFie /*! * This method makes the assumption that _discr_per_cell is set. * This method reduces as much as possible number size of _loc. - * This method is usefull when several set on same cells has been done and that some Gauss Localization are no more used. + * This method is useful when several set on same cells has been done and that some Gauss Localization are no more used. */ void MEDCouplingFieldDiscretizationGauss::zipGaussLocalizations() { @@ -1478,7 +1478,7 @@ void MEDCouplingFieldDiscretizationGauss::zipGaussLocalizations() } /*! - * This method is usefull when 'this' describes a field discretization with several gauss discretization on a \b same cell type. + * This method is useful when 'this' describes a field discretization with several gauss discretization on a \b same cell type. * For example same NORM_TRI3 cells having 6 gauss points and others with 12 gauss points. * This method returns 2 arrays with same size : the return value and 'locIds' output parameter. * For a given i into [0,locIds.size) ret[i] represents the set of cell ids of i_th set an locIds[i] represents the set of discretisation of the set. diff --git a/src/MEDCoupling/MEDCouplingFieldDouble.cxx b/src/MEDCoupling/MEDCouplingFieldDouble.cxx index 473f69698..fd0cb1740 100644 --- a/src/MEDCoupling/MEDCouplingFieldDouble.cxx +++ b/src/MEDCoupling/MEDCouplingFieldDouble.cxx @@ -868,7 +868,7 @@ void MEDCouplingFieldDouble::normL2(double *res) const throw(INTERP_KERNEL::Exce /*! * Returns the accumulation (the sum) of comId_th component of each tuples weigthed by the field * returns by getWeightingField relative of the _type of field of default array. - * This method is usefull to check the conservativity of interpolation method. + * This method is useful to check the conservativity of interpolation method. */ double MEDCouplingFieldDouble::integral(int compId, bool isWAbs) const throw(INTERP_KERNEL::Exception) { @@ -888,7 +888,7 @@ double MEDCouplingFieldDouble::integral(int compId, bool isWAbs) const throw(INT /*! * Returns the accumulation (the sum) of each tuples weigthed by the field * returns by getWeightingField relative of the _type of field of default array. - * This method is usefull to check the conservativity of interpolation method. + * This method is useful to check the conservativity of interpolation method. */ void MEDCouplingFieldDouble::integral(bool isWAbs, double *res) const throw(INTERP_KERNEL::Exception) { diff --git a/src/MEDCoupling/MEDCouplingPointSet.cxx b/src/MEDCoupling/MEDCouplingPointSet.cxx index 6a3f9df19..c83a4a642 100644 --- a/src/MEDCoupling/MEDCouplingPointSet.cxx +++ b/src/MEDCoupling/MEDCouplingPointSet.cxx @@ -843,7 +843,7 @@ MEDCouplingMesh *MEDCouplingPointSet::buildPart(const int *start, const int *end * This method build a part of 'this' by simply keeping cells whose ids are in ['start','end') \b and potentially reduces the nodes set * behind returned mesh. This cause an overhead but it is lesser in memory. * This method returns an array too. This array allows to the caller to know the mapping between nodeids in 'this' and nodeids in - * returned mesh. This is quite usefull for MEDCouplingFieldDouble on nodes for example... + * returned mesh. This is quite useful for MEDCouplingFieldDouble on nodes for example... * 'arr' is in old2New format of size ret->getNumberOfCells like MEDCouplingUMesh::zipCoordsTraducer is. * The returned mesh has to be managed by the caller. */ diff --git a/src/MEDCoupling/MEDCouplingUMesh.cxx b/src/MEDCoupling/MEDCouplingUMesh.cxx index 6f83da0a4..312e9bc53 100644 --- a/src/MEDCoupling/MEDCouplingUMesh.cxx +++ b/src/MEDCoupling/MEDCouplingUMesh.cxx @@ -952,7 +952,7 @@ void MEDCouplingUMesh::convertAllToPoly() * When called 'this' is an invalid mesh on MED sense. This method will correct that for polyhedra. * In case of presence of polyhedron that has not the extruded aspect (2 faces with the same number of nodes) an exception is thrown and 'this' * remains unchanged. - * This method is usefull only for users that wants to build extruded unstructured mesh. + * This method is useful only for users that wants to build extruded unstructured mesh. * This method is a convenient one that avoids boring polyhedra setting during insertNextCell process. * In case of success, 'this' has be corrected contains the same number of cells and is valid in MED sense. */ @@ -3143,7 +3143,7 @@ DataArrayDouble *MEDCouplingUMesh::getPartMeasureField(bool isAbs, const int *be } /*! - * This methods returns a field on nodes and no time. This method is usefull to check "P1*" conservative interpolators. + * This methods returns a field on nodes and no time. This method is useful to check "P1*" conservative interpolators. * This field returns the getMeasureField of the dualMesh in P1 sens of 'this'. */ MEDCouplingFieldDouble *MEDCouplingUMesh::getMeasureFieldOnNode(bool isAbs) const @@ -5202,7 +5202,7 @@ void MEDCouplingUMesh::subDivide2DMesh(const int *nodeSubdived, const int *nodeI * nodal connectivity will be transform to a NORM_TRI3 cell. * This method works \b only \b on \b linear cells. * This method works on nodes ids, that is to say a call to ParaMEDMEM::MEDCouplingUMesh::mergeNodes - * method could be usefull before calling this method in case of presence of several pair of nodes located on same position. + * method could be useful before calling this method in case of presence of several pair of nodes located on same position. * This method throws an exception if 'this' is not fully defined (connectivity). * This method throws an exception too if a "too" degenerated cell is detected. For example a NORM_TRI3 with 3 times the same node id. */ @@ -5988,7 +5988,7 @@ MEDCouplingUMesh *MEDCouplingUMesh::emulateMEDMEMBDC(const MEDCouplingUMesh *nM1 /*! * This method sorts cell in this so that cells are sorted by cell type specified by MEDMEM and so for MED file. - * It avoids to deal with renum in MEDLoader so it is usefull for MED file R/W with multi types. + * It avoids to deal with renum in MEDLoader so it is useful for MED file R/W with multi types. * This method returns a newly allocated array old2New. * This method expects that connectivity of this is set. If not an exception will be thrown. Coordinates are not taken into account. */ @@ -6676,7 +6676,7 @@ MEDCouplingUMesh *MEDCouplingUMesh::FuseUMeshesOnSameCoords(const std::vectorgetNumberOfTuples()-1. + * This method is useful to see if a mesh is contiguous regarding its connectivity. If it is not the case the size of returned array is different from arrIndxIn->getNumberOfTuples()-1. * * \param [in] arrIn arr origin array from which the extraction will be done. * \param [in] arrIndxIn is the input index array allowing to walk into \b arrIn @@ -8109,7 +8109,7 @@ DataArrayInt *MEDCouplingUMesh::ComputeSpreadZoneGradually(const DataArrayInt *a * This method start from id 0 that will be contained in output DataArrayInt. It searches then all neighbors of id0 regarding arrIn[arrIndxIn[0]:arrIndxIn[0+1]]. * Then it is repeated recursively until either all ids are fetched or no more ids are reachable step by step. * A negative value in \b arrIn means that it is ignored. - * This method is usefull to see if a mesh is contiguous regarding its connectivity. If it is not the case the size of returned array is different from arrIndxIn->getNumberOfTuples()-1. + * This method is useful to see if a mesh is contiguous regarding its connectivity. If it is not the case the size of returned array is different from arrIndxIn->getNumberOfTuples()-1. * \param [in] seedBg the begin pointer (included) of an array containing the seed of the search zone * \param [in] seedEnd the end pointer (not included) of an array containing the seed of the search zone * \param [in] arrIn arr origin array from which the extraction will be done.