X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FStdMeshers%2FStdMeshers_NumberOfSegments.hxx;h=05faf2ed3de365204698fc2881df772b943334e9;hb=refs%2Ftags%2FT3_2_0b2;hp=79147e1a2aca6cc735e99d5d8bd4e45287a6a56f;hpb=c3bf92bd87b770fd81631a3853f7f5bb1ac6a4e8;p=modules%2Fsmesh.git diff --git a/src/StdMeshers/StdMeshers_NumberOfSegments.hxx b/src/StdMeshers/StdMeshers_NumberOfSegments.hxx index 79147e1a2..05faf2ed3 100644 --- a/src/StdMeshers/StdMeshers_NumberOfSegments.hxx +++ b/src/StdMeshers/StdMeshers_NumberOfSegments.hxx @@ -17,7 +17,7 @@ // 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.opencascade.org/SALOME/ or email : webmaster.salome@opencascade.org +// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com // // // @@ -32,7 +32,14 @@ #include "SMESH_Hypothesis.hxx" #include "Utils_SALOME_Exception.hxx" +#include +/*! + * \brief This class represents hypothesis for 1d algorithm + * + * It provides parameters for subdivision an edge by various + * distribution types, considering the given number of resulting segments + */ class StdMeshers_NumberOfSegments: public SMESH_Hypothesis { @@ -40,24 +47,141 @@ public: StdMeshers_NumberOfSegments(int hypId, int studyId, SMESH_Gen* gen); virtual ~StdMeshers_NumberOfSegments(); + // Builds point distribution according to passed function + const std::vector& BuildDistributionExpr( const char*, int, int ) throw ( SALOME_Exception ); + const std::vector& BuildDistributionTab( const std::vector&, int, int ) throw ( SALOME_Exception ); + + /*! + * \brief Set the number of segments + * \param segmentsNumber - must be greater than zero + */ void SetNumberOfSegments(int segmentsNumber) throw (SALOME_Exception); + /*! + * \brief Get the number of segments + */ int GetNumberOfSegments() const; - void SetScaleFactor(double scaleFactor) + /*! + * \brief This enumeration presents available types of distribution + */ + enum DistrType + { + DT_Regular, //!< equidistant distribution + DT_Scale, //!< scale distribution + DT_TabFunc, //!< distribution with density function presented by table + DT_ExprFunc //!< distribution with density function presented by expression + }; + + /*! + * \brief Set distribution type + */ + void SetDistrType(DistrType typ) + throw (SALOME_Exception); + + /*! + * \brief Get distribution type + */ + DistrType GetDistrType() const; + + /*! + * \brief Set scale factor for scale distribution + * \param scaleFactor - positive value different from 1 + * + * Throws SALOME_Exception if distribution type is not DT_Scale, + * or scaleFactor is not a positive value different from 1 + */ + virtual void SetScaleFactor(double scaleFactor) + throw (SALOME_Exception); + + /*! + * \brief Get scale factor for scale distribution + * + * Throws SALOME_Exception if distribution type is not DT_Scale + */ + double GetScaleFactor() const + throw (SALOME_Exception); + + /*! + * \brief Set table function for distribution DT_TabFunc + * \param table - this vector contains the pairs (parameter, value) + * following each by other, so the number of elements in the vector + * must be even. The parameters must be in range [0,1] and sorted in + * increase order. The values of function must be positive. + * + * Throws SALOME_Exception if distribution type is not DT_TabFunc + */ + void SetTableFunction(const std::vector& table) + throw (SALOME_Exception); + + /*! + * \brief Get table function for distribution DT_TabFunc + * + * Throws SALOME_Exception if distribution type is not DT_TabFunc + */ + const std::vector& GetTableFunction() const + throw (SALOME_Exception); + + /*! + * \brief Set expression function for distribution DT_ExprFunc + * \param expr - string containing the expression of the function + * f(t), e.g. "sin(t)" + * + * Throws SALOME_Exception if distribution type is not DT_ExprFunc + */ + void SetExpressionFunction( const char* expr) + throw (SALOME_Exception); + + /*! + * \brief Get expression function for distribution DT_ExprFunc + * + * Throws SALOME_Exception if distribution type is not DT_ExprFunc + */ + const char* GetExpressionFunction() const throw (SALOME_Exception); - double GetScaleFactor() const; + /*! + * \brief Set conversion mode. When it is 0, it means "exponent mode": + * the function of distribution of density is used as an exponent of 10, i,e, 10^f(t). + * When it is 1, it means "cut negative mode". The function of distribution is used as + * F(t), where F(t0)=f(t0), if f(t0)>=0, otherwise F(t0) = 0. + * This mode is sensible only when function distribution is used (DT_TabFunc or DT_ExprFunc) + * + * Throws SALOME_Exception if distribution type is not functional + */ + void SetConversionMode( int conv ) + throw (SALOME_Exception); + + /*! + * \brief Returns conversion mode + * + * Throws SALOME_Exception if distribution type is not functional + */ + int ConversionMode() const + throw (SALOME_Exception); + + + /*! + * \brief Initialize number of segments by the mesh built on the geometry + * \param theMesh - the built mesh + * \param theShape - the geometry of interest + * \retval bool - true if parameter values have been successfully defined + */ + virtual bool SetParametersByMesh(const SMESH_Mesh* theMesh, const TopoDS_Shape& theShape); - virtual ostream & SaveTo(ostream & save); - virtual istream & LoadFrom(istream & load); - friend ostream& operator << (ostream & save, StdMeshers_NumberOfSegments & hyp); - friend istream& operator >> (istream & load, StdMeshers_NumberOfSegments & hyp); + virtual std::ostream & SaveTo(std::ostream & save); + virtual std::istream & LoadFrom(std::istream & load); + friend std::ostream& operator << (std::ostream & save, StdMeshers_NumberOfSegments & hyp); + friend std::istream& operator >> (std::istream & load, StdMeshers_NumberOfSegments & hyp); protected: - int _numberOfSegments; - double _scaleFactor; + int _numberOfSegments; //!< an edge will be split on to this number of segments + DistrType _distrType; //!< the type of distribution of density function + double _scaleFactor; //!< the scale parameter for DT_Scale + std::vector _table, _distr; //!< the table for DT_TabFunc, a sequence of pairs of numbers + std::string _func; //!< the expression of the function for DT_ExprFunc + int _convMode; //!< flag of conversion mode: 0=exponent, 1=cut negative }; #endif