Salome HOME
52566]: TC7.5.0: Empty group of Balls at Diameter Equal to filter
[modules/smesh.git] / src / StdMeshers / StdMeshers_NumberOfSegments.cxx
1 // Copyright (C) 2007-2014  CEA/DEN, EDF R&D, OPEN CASCADE
2 //
3 // Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
5 //
6 // This library is free software; you can redistribute it and/or
7 // modify it under the terms of the GNU Lesser General Public
8 // License as published by the Free Software Foundation; either
9 // version 2.1 of the License, or (at your option) any later version.
10 //
11 // This library is distributed in the hope that it will be useful,
12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14 // Lesser General Public License for more details.
15 //
16 // You should have received a copy of the GNU Lesser General Public
17 // License along with this library; if not, write to the Free Software
18 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
19 //
20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
21 //
22
23 //  SMESH SMESH : implementaion of SMESH idl descriptions
24 //  File   : StdMeshers_NumberOfSegments.cxx
25 //           Moved here from SMESH_NumberOfSegments.cxx
26 //  Author : Paul RASCLE, EDF
27 //  Module : SMESH
28 //
29 #include "StdMeshers_NumberOfSegments.hxx"
30
31 #include "StdMeshers_Distribution.hxx"
32 #include "SMESHDS_SubMesh.hxx"
33 #include "SMESH_Mesh.hxx"
34 #include "SMESH_Comment.hxx"
35
36 #include <ExprIntrp_GenExp.hxx>
37 #include <Expr_Array1OfNamedUnknown.hxx>
38 #include <Expr_NamedUnknown.hxx>
39 #include <TColStd_Array1OfReal.hxx>
40 #include <TCollection_AsciiString.hxx>
41 #include <TopExp.hxx>
42 #include <TopTools_IndexedMapOfShape.hxx>
43
44 #if (OCC_VERSION_MAJOR << 16 | OCC_VERSION_MINOR << 8 | OCC_VERSION_MAINTENANCE) > 0x060100
45 #define NO_CAS_CATCH
46 #endif
47
48 #include <Standard_Failure.hxx>
49
50 #ifdef NO_CAS_CATCH
51 #include <Standard_ErrorHandler.hxx>
52 #endif
53
54 #include <Basics_Utils.hxx>
55
56 using namespace StdMeshers;
57 using namespace std;
58
59 const double PRECISION = 1e-7;
60
61 //=============================================================================
62 /*!
63  *  
64  */
65 //=============================================================================
66
67 StdMeshers_NumberOfSegments::StdMeshers_NumberOfSegments(int         hypId,
68                                                          int         studyId,
69                                                          SMESH_Gen * gen)
70   : SMESH_Hypothesis(hypId, studyId, gen),
71     _numberOfSegments(15),//issue 19923
72     _distrType(DT_Regular),
73     _scaleFactor(1.),
74     _convMode(1)  //cut negative by default
75 {
76   _name = "NumberOfSegments";
77   _param_algo_dim = 1;
78 }
79
80 //=============================================================================
81 /*!
82  *  
83  */
84 //=============================================================================
85
86 StdMeshers_NumberOfSegments::~StdMeshers_NumberOfSegments()
87 {
88 }
89
90 //=============================================================================
91 /*!
92  *  
93  */
94 //=============================================================================
95 const vector<double>&
96 StdMeshers_NumberOfSegments::BuildDistributionExpr( const char* expr,int nbSeg,int conv )
97   throw ( SALOME_Exception )
98 {
99   if( !buildDistribution( TCollection_AsciiString( ( Standard_CString )expr ), conv, 0.0, 1.0, nbSeg, _distr, 1E-4 ) )
100     _distr.resize( 0 );
101   return _distr;
102 }
103
104 const vector<double>&
105 StdMeshers_NumberOfSegments::BuildDistributionTab( const vector<double>& tab,
106                                                    int nbSeg,
107                                                    int conv )
108   throw ( SALOME_Exception )
109 {
110   if( !buildDistribution( tab, conv, 0.0, 1.0, nbSeg, _distr, 1E-4 ) )
111     _distr.resize( 0 );
112   return _distr;
113 }
114
115 //=============================================================================
116 /*!
117  *  
118  */
119 //=============================================================================
120
121 void StdMeshers_NumberOfSegments::SetNumberOfSegments(int segmentsNumber)
122 throw(SALOME_Exception)
123 {
124   int oldNumberOfSegments = _numberOfSegments;
125   if (segmentsNumber <= 0)
126     throw SALOME_Exception(LOCALIZED("number of segments must be positive"));
127   _numberOfSegments = segmentsNumber;
128
129   if (oldNumberOfSegments != _numberOfSegments)
130     NotifySubMeshesHypothesisModification();
131 }
132
133 //=============================================================================
134 /*!
135  *  
136  */
137 //=============================================================================
138
139 int StdMeshers_NumberOfSegments::GetNumberOfSegments() const
140 {
141   return _numberOfSegments;
142 }
143
144 //================================================================================
145 /*!
146  * 
147  */
148 //================================================================================
149
150 void StdMeshers_NumberOfSegments::SetDistrType(DistrType typ)
151   throw(SALOME_Exception)
152 {
153   if (typ < DT_Regular || typ > DT_ExprFunc)
154     throw SALOME_Exception(LOCALIZED("distribution type is out of range"));
155
156   if (typ != _distrType)
157   {
158     _distrType = typ;
159     NotifySubMeshesHypothesisModification();
160   }
161 }
162
163 //================================================================================
164 /*!
165  * 
166  */
167 //================================================================================
168
169 StdMeshers_NumberOfSegments::DistrType StdMeshers_NumberOfSegments::GetDistrType() const
170 {
171   return _distrType;
172 }
173
174 //================================================================================
175 /*!
176  * 
177  */
178 //================================================================================
179
180 void StdMeshers_NumberOfSegments::SetScaleFactor(double scaleFactor)
181   throw(SALOME_Exception)
182 {
183   if (_distrType != DT_Scale)
184     _distrType = DT_Scale;
185     //throw SALOME_Exception(LOCALIZED("not a scale distribution"));
186   if (scaleFactor < PRECISION)
187     throw SALOME_Exception(LOCALIZED("scale factor must be positive"));
188   //if (fabs(scaleFactor - 1.0) < PRECISION)
189   //  throw SALOME_Exception(LOCALIZED("scale factor must not be equal to 1"));
190
191   if (fabs(_scaleFactor - scaleFactor) > PRECISION)
192   {
193     _scaleFactor = scaleFactor;
194     NotifySubMeshesHypothesisModification();
195   }
196 }
197
198 //================================================================================
199 /*!
200  * 
201  */
202 //================================================================================
203
204 double StdMeshers_NumberOfSegments::GetScaleFactor() const
205   throw(SALOME_Exception)
206 {
207   if (_distrType != DT_Scale)
208     throw SALOME_Exception(LOCALIZED("not a scale distribution"));
209   return _scaleFactor;
210 }
211
212 //================================================================================
213 /*!
214  * 
215  */
216 //================================================================================
217
218 void StdMeshers_NumberOfSegments::SetTableFunction(const vector<double>& table)
219   throw(SALOME_Exception)
220 {
221   if (_distrType != DT_TabFunc)
222     _distrType = DT_TabFunc;
223   //throw SALOME_Exception(LOCALIZED("not a table function distribution"));
224   if ( (table.size() % 2) != 0 )
225     throw SALOME_Exception(LOCALIZED("odd size of vector of table function"));
226
227   int i;
228   double prev = -PRECISION;
229   bool isSame = table.size() == _table.size();
230
231   bool pos = false;
232   for (i=0; i < table.size()/2; i++) {
233     double par = table[i*2];
234     double val = table[i*2+1];
235     if( _convMode==0 )
236     {
237       try {
238 #ifdef NO_CAS_CATCH
239         OCC_CATCH_SIGNALS;
240 #endif
241         val = pow( 10.0, val );
242       } catch(Standard_Failure) {
243         Handle(Standard_Failure) aFail = Standard_Failure::Caught();
244         throw SALOME_Exception( LOCALIZED( "invalid value"));
245         return;
246       }
247     }
248     else if( _convMode==1 && val<0.0 )
249       val = 0.0;
250
251     if ( par<0 || par > 1)
252       throw SALOME_Exception(LOCALIZED("parameter of table function is out of range [0,1]"));
253     if ( fabs(par-prev)<PRECISION )
254       throw SALOME_Exception(LOCALIZED("two parameters are the same"));
255     if ( val < 0 )
256       throw SALOME_Exception(LOCALIZED("value of table function is not positive"));
257     if( val>PRECISION )
258       pos = true;
259     if (isSame)
260     {
261       double oldpar = _table[i*2];
262       double oldval = _table[i*2+1];
263       if (fabs(par - oldpar) > PRECISION || fabs(val - oldval) > PRECISION)
264         isSame = false;
265     }
266     prev = par;
267   }
268
269   if( !pos )
270     throw SALOME_Exception(LOCALIZED("value of table function is not positive"));
271
272   if( pos && !isSame )
273   {
274     _table = table;
275     NotifySubMeshesHypothesisModification();
276   }
277 }
278
279 //================================================================================
280 /*!
281  * 
282  */
283 //================================================================================
284
285 const vector<double>& StdMeshers_NumberOfSegments::GetTableFunction() const
286   throw(SALOME_Exception)
287 {
288   if (_distrType != DT_TabFunc)
289     throw SALOME_Exception(LOCALIZED("not a table function distribution"));
290   return _table;
291 }
292
293 //================================================================================
294 /*! check if only 't' is unknown variable in expression
295  */
296 //================================================================================
297 bool isCorrectArg( const Handle( Expr_GeneralExpression )& expr )
298 {
299   Handle( Expr_NamedUnknown ) sub = Handle( Expr_NamedUnknown )::DownCast( expr );
300   if( !sub.IsNull() )
301     return sub->GetName()=="t";
302
303   bool res = true;
304   for( int i=1, n=expr->NbSubExpressions(); i<=n && res; i++ )
305   {
306     Handle( Expr_GeneralExpression ) sub = expr->SubExpression( i );
307     Handle( Expr_NamedUnknown ) name = Handle( Expr_NamedUnknown )::DownCast( sub );
308     if( !name.IsNull() )
309     {
310       if( name->GetName()!="t" )
311         res = false;
312     }
313     else
314       res = isCorrectArg( sub );
315   }
316   return res;
317 }
318
319 //================================================================================
320 /*! this function parses the expression 'str' in order to check if syntax is correct
321  *  ( result in 'syntax' ) and if only 't' is unknown variable in expression ( result in 'args' )
322  */
323 //================================================================================
324 bool process( const TCollection_AsciiString& str, int convMode,
325               bool& syntax, bool& args,
326               bool& non_neg, bool& non_zero,
327               bool& singulars, double& sing_point )
328 {
329   Kernel_Utils::Localizer loc;
330
331   bool parsed_ok = true;
332   Handle( ExprIntrp_GenExp ) myExpr;
333   try {
334 #ifdef NO_CAS_CATCH
335     OCC_CATCH_SIGNALS;
336 #endif
337     myExpr = ExprIntrp_GenExp::Create();
338     myExpr->Process( str.ToCString() );
339   } catch(Standard_Failure) {
340     Handle(Standard_Failure) aFail = Standard_Failure::Caught();
341     parsed_ok = false;
342   }
343
344   syntax = false;
345   args = false;
346   if( parsed_ok && myExpr->IsDone() )
347   {
348     syntax = true;
349     args = isCorrectArg( myExpr->Expression() );
350   }
351
352   bool res = parsed_ok && syntax && args;
353   if( !res )
354     myExpr.Nullify();
355
356   non_neg = true;
357   singulars = false;
358   non_zero = false;
359
360   if( res )
361   {
362     FunctionExpr f( str.ToCString(), convMode );
363     const int max = 500;
364     for( int i=0; i<=max; i++ )
365     {
366       double t = double(i)/double(max), val;
367       if( !f.value( t, val ) )
368       {
369         sing_point = t;
370         singulars = true;
371         break;
372       }
373       if( val<0 )
374       {
375         non_neg = false;
376         break;
377       }
378       if( val>PRECISION )
379         non_zero = true;
380     }
381   }
382
383   return res && non_neg && non_zero && ( !singulars );
384 }
385
386 //================================================================================
387 /*!
388  * 
389  */
390 //================================================================================
391
392 void StdMeshers_NumberOfSegments::SetExpressionFunction(const char* expr)
393   throw(SALOME_Exception)
394 {
395   if (_distrType != DT_ExprFunc)
396     _distrType = DT_ExprFunc;
397     //throw SALOME_Exception(LOCALIZED("not an expression function distribution"));
398
399   string func = CheckExpressionFunction( expr, _convMode );
400   if( _func != func )
401   {
402     _func = func;
403     NotifySubMeshesHypothesisModification();
404   }
405 }
406
407 //=======================================================================
408 //function : CheckExpressionFunction
409 //purpose  : Checks validity of  the expression of the function f(t), e.g. "sin(t)".
410 //           In case of validity returns a cleaned expression
411 //=======================================================================
412
413 std::string
414 StdMeshers_NumberOfSegments::CheckExpressionFunction( const std::string& expr,
415                                                       const int          convMode)
416     throw (SALOME_Exception)
417 {
418   // remove white spaces
419   TCollection_AsciiString str((Standard_CString)expr.c_str());
420   str.RemoveAll(' ');
421   str.RemoveAll('\t');
422   str.RemoveAll('\r');
423   str.RemoveAll('\n');
424
425   bool syntax, args, non_neg, singulars, non_zero;
426   double sing_point;
427   bool res = process( str, convMode, syntax, args, non_neg, non_zero, singulars, sing_point );
428   if( !res )
429   {
430     if( !syntax )
431       throw SALOME_Exception(SMESH_Comment("invalid expression syntax: ") << str );
432     if( !args )
433       throw SALOME_Exception(LOCALIZED("only 't' may be used as function argument"));
434     if( !non_neg )
435       throw SALOME_Exception(LOCALIZED("only non-negative function can be used"));
436     if( singulars )
437     {
438       char buf[1024];
439       sprintf( buf, "Function has singular point in %.3f", sing_point );
440       throw SALOME_Exception( buf );
441     }
442     if( !non_zero )
443       throw SALOME_Exception(LOCALIZED("f(t)=0 cannot be used"));
444   }
445  
446   return str.ToCString();
447 }
448
449 //================================================================================
450 /*!
451  * 
452  */
453 //================================================================================
454
455 const char* StdMeshers_NumberOfSegments::GetExpressionFunction() const
456   throw(SALOME_Exception)
457 {
458   if (_distrType != DT_ExprFunc)
459     throw SALOME_Exception(LOCALIZED("not an expression function distribution"));
460   return _func.c_str();
461 }
462
463 //================================================================================
464 /*!
465  * 
466  */
467 //================================================================================
468
469 void StdMeshers_NumberOfSegments::SetConversionMode( int conv )
470   throw(SALOME_Exception)
471 {
472 //   if (_distrType != DT_TabFunc && _distrType != DT_ExprFunc)
473 //     throw SALOME_Exception(LOCALIZED("not a functional distribution"));
474
475   if( conv != _convMode )
476   {
477     _convMode = conv;
478     NotifySubMeshesHypothesisModification();
479   }
480 }
481
482 //================================================================================
483 /*!
484  * 
485  */
486 //================================================================================
487
488 int StdMeshers_NumberOfSegments::ConversionMode() const
489   throw(SALOME_Exception)
490 {
491 //   if (_distrType != DT_TabFunc && _distrType != DT_ExprFunc)
492 //     throw SALOME_Exception(LOCALIZED("not a functional distribution"));
493   return _convMode;
494 }
495
496 //=============================================================================
497 /*!
498  *  
499  */
500 //=============================================================================
501
502 ostream & StdMeshers_NumberOfSegments::SaveTo(ostream & save)
503 {
504   int listSize = _edgeIDs.size();
505   save << _numberOfSegments << " " << (int)_distrType;
506   switch (_distrType)
507   {
508   case DT_Scale:
509     save << " " << _scaleFactor;
510     break;
511   case DT_TabFunc:
512     int i;
513     save << " " << _table.size();
514     for (i=0; i < _table.size(); i++)
515       save << " " << _table[i];
516     break;
517   case DT_ExprFunc:
518     save << " " << _func;
519     break;
520   case DT_Regular:
521   default:
522     break;
523   }
524
525   if (_distrType == DT_TabFunc || _distrType == DT_ExprFunc)
526     save << " " << _convMode;
527
528   if ( _distrType != DT_Regular && listSize > 0 ) {
529     save << " " << listSize;
530     for ( int i = 0; i < listSize; i++ )
531       save << " " << _edgeIDs[i];
532     save << " " << _objEntry;
533   }
534   
535   return save;
536 }
537
538 //=============================================================================
539 /*!
540  *  
541  */
542 //=============================================================================
543
544 istream & StdMeshers_NumberOfSegments::LoadFrom(istream & load)
545 {
546   bool isOK = true;
547   int a;
548
549   // read number of segments
550   isOK = (load >> a);
551   if (isOK)
552     _numberOfSegments = a;
553   else
554     load.clear(ios::badbit | load.rdstate());
555
556   // read second stored value. It can be two variants here:
557   // 1. If the hypothesis is stored in old format (nb.segments and scale factor),
558   //    we wait here the scale factor, which is double.
559   // 2. If the hypothesis is stored in new format
560   //    (nb.segments, distr.type, some other params.),
561   //    we wait here the ditribution type, which is integer
562   double scale_factor;
563   isOK = (load >> scale_factor);
564   a = (int)scale_factor;
565
566   // try to interprete ditribution type,
567   // supposing that this hypothesis was written in the new format
568   if (isOK)
569   {
570     if (a < DT_Regular || a > DT_ExprFunc)
571       _distrType = DT_Regular;
572     else
573       _distrType = (DistrType) a;
574   }
575   else
576     load.clear(ios::badbit | load.rdstate());
577
578   // parameters of distribution
579   double b;
580   switch (_distrType)
581   {
582   case DT_Scale:
583     {
584       isOK = (load >> b);
585       if (isOK)
586         _scaleFactor = b;
587       else
588       {
589         load.clear(ios::badbit | load.rdstate());
590         // this can mean, that the hypothesis is stored in old format
591         _distrType = DT_Regular;
592         _scaleFactor = scale_factor;
593       }
594     }
595     break;
596   case DT_TabFunc:
597     {
598       isOK = (load >> a);
599       if (isOK)
600       {
601         _table.resize(a, 0.);
602         int i;
603         for (i=0; i < _table.size(); i++)
604         {
605           isOK = (load >> b);
606           if (isOK)
607             _table[i] = b;
608           else
609             load.clear(ios::badbit | load.rdstate());
610         }
611       }
612       else
613       {
614         load.clear(ios::badbit | load.rdstate());
615         // this can mean, that the hypothesis is stored in old format
616         _distrType = DT_Regular;
617         _scaleFactor = scale_factor;
618       }
619     }
620     break;
621   case DT_ExprFunc:
622     {
623       string str;
624       isOK = (load >> str);
625       if (isOK)
626         _func = str;
627       else
628       {
629         load.clear(ios::badbit | load.rdstate());
630         // this can mean, that the hypothesis is stored in old format
631         _distrType = DT_Regular;
632         _scaleFactor = scale_factor;
633       }
634     }
635     break;
636   case DT_Regular:
637   default:
638     break;
639   }
640
641   if (_distrType == DT_TabFunc || _distrType == DT_ExprFunc)
642   {
643     isOK = (load >> a);
644     if (isOK)
645       _convMode = a;
646     else
647       load.clear(ios::badbit | load.rdstate());
648   }
649
650   // load reversed edges IDs
651   int intVal;
652   isOK = (load >> intVal);
653   if ( isOK && _distrType != DT_Regular && intVal > 0 ) {
654     _edgeIDs.reserve( intVal );
655     for (int i = 0; i < _edgeIDs.capacity() && isOK; i++) {
656       isOK = (load >> intVal);
657       if ( isOK ) _edgeIDs.push_back( intVal );
658     }
659     isOK = (load >> _objEntry);
660   }
661
662   return load;
663 }
664
665 //=============================================================================
666 /*!
667  *  
668  */
669 //=============================================================================
670
671 ostream & operator <<(ostream & save, StdMeshers_NumberOfSegments & hyp)
672 {
673   return hyp.SaveTo( save );
674 }
675
676 //=============================================================================
677 /*!
678  *  
679  */
680 //=============================================================================
681
682 istream & operator >>(istream & load, StdMeshers_NumberOfSegments & hyp)
683 {
684   return hyp.LoadFrom( load );
685 }
686
687 //================================================================================
688 /*!
689  * \brief Initialize number of segments by the mesh built on the geometry
690  * \param theMesh - the built mesh
691  * \param theShape - the geometry of interest
692  * \retval bool - true if parameter values have been successfully defined
693  */
694 //================================================================================
695
696 bool StdMeshers_NumberOfSegments::SetParametersByMesh(const SMESH_Mesh*   theMesh,
697                                                       const TopoDS_Shape& theShape)
698 {
699   if ( !theMesh || theShape.IsNull() )
700     return false;
701
702   _numberOfSegments = 0;
703   _distrType = DT_Regular;
704
705   int nbEdges = 0;
706   TopTools_IndexedMapOfShape edgeMap;
707   TopExp::MapShapes( theShape, TopAbs_EDGE, edgeMap );
708   SMESHDS_Mesh* aMeshDS = const_cast< SMESH_Mesh* >( theMesh )->GetMeshDS();
709   for ( int i = 1; i <= edgeMap.Extent(); ++i )
710   {
711     // get current segment length
712     SMESHDS_SubMesh * eSubMesh = aMeshDS->MeshElements( edgeMap( i ));
713     if ( eSubMesh && eSubMesh->NbElements())
714       _numberOfSegments += eSubMesh->NbElements();
715
716     ++nbEdges;
717   }
718   if ( nbEdges )
719     _numberOfSegments /= nbEdges;
720
721   if (_numberOfSegments == 0) _numberOfSegments = 1;
722
723   return nbEdges;
724 }
725 //================================================================================
726 /*!
727  * \brief Initialize my parameter values by default parameters.
728  *  \retval bool - true if parameter values have been successfully defined
729  */
730 //================================================================================
731
732 bool StdMeshers_NumberOfSegments::SetParametersByDefaults(const TDefaults&  dflts,
733                                                           const SMESH_Mesh* /*theMesh*/)
734 {
735   return (_numberOfSegments = dflts._nbSegments );
736 }
737
738 //=============================================================================
739 /*!
740  *  
741  */
742 //=============================================================================
743
744 void StdMeshers_NumberOfSegments::SetReversedEdges( std::vector<int>& ids )
745 {
746   if ( ids != _edgeIDs ) {
747     _edgeIDs = ids;
748
749     NotifySubMeshesHypothesisModification();
750   }
751 }
752