Differences

This shows you the differences between two versions of the page.

--- doc:user:geometry:user:operateurs [2014/08/07 19:04] – joris
+++ doc:user:geometry:user:operateurs [2016/03/30 15:23] (current) – external edit 127.0.0.1
@@ Line 1: / Line 1: @@
-====== Operators ======
+====== Geometry/Mesh Operators ======
 ===== Introduction =====
-Operators are used to move a geometry, meshed or not, from one position to another. The syntax is as follow:
+These kinds of operators are used to move/deform a geometry and its associated mesh from one configuration to another. The generic syntax is as follow:
-  op = GivenOperator(arg1, arg2, ...)
+  op = XXXOperator(arg1, arg2, ...)
-  sideset(1).move(op)
+  target.move(op)
-As can be seen, the operator ''op'' must first be created. It takes several arguments, which can be values of Metafor objects (see below for specific operators). Then, the operator is applied to the object which must be moved (here, face #1).
+where ''target'' is a geometrical entity (e.g. ''sideset(1)'', ''curveset(2)'')
+As can be seen, the operator ''op'' must first be created. It takes several arguments, which can be values of Metafor objects (see below for specific operators). Then, the operator is applied to the ''target'' object (e.g. Side #1 or Curve #2).
-===== Translating operator =====
-This operator translates a geometry, meshed or not. The motion is defined by a ''Vect3'':
+===== Translation Operator =====
-  op = TranslationOperator([Vect3] disp)
+This operator translates a geometry, meshed or not. The displacement is defined by a ''Vect3'':
-  sideset(1).move(op)
+  op = TranslationOperator(disp)
-===== Rotating operator =====
+where
+| ''disp''   | ''Vect3'' | displacement vector |
+===== Rotation Operator =====
 This operator is used to rotate a geometry, meshed or not, along an axis. The rotation is defined by and angle (in radian) and an ''[[doc:user:geometry:user:axes|Axis]]'':
   op = RotationOperator(axis, angle)
-  sideset(1).move(op)
+where
+| ''axis''   | ''[[doc:user:geometry:user:axes|Axis]]'' | rotation axis     |
+| ''angle''  | ''float''                                | angle (in radian) |
-===== Aligning operator =====
+===== Alignment Operator =====
 This operator is used to apply a rigid body motion (translation + rotation), to a geometric entity, meshed or not. This rigid body mode is defined by two ''[[doc:user:geometry:user:triedres]]'':
   op = AlignmentOperator(trihedronRef, trihedronMesh)
-  sideset(1).move(op)
-''trihedronRef'' is the trihedron to which the side 1 must be moved, when ''trihedronMesh'' is a trihedron modelling a local frame of the side to be moved.
+''trihedronRef'' is the trihedron to which the target must be moved, when ''trihedronMesh'' is a trihedron modelling a local frame of the side to be moved.
-===== Point reflection operator =====
+===== Point-Reflection Operator =====
 This operator is used to apply a point reflection (with or without a translation) to a geometric entity, meshed or not. This point reflection is defined by an ''[[axes|Axis]]'' and an amplitude ''ampl'':
   op = RadialOperator(axe, ampl)
-  op.setDisplacement([Vect3] disp)
+  op.setDisplacement(disp)
-  sideset(1).move(op)
-The axis indicates the direction of the point reflection.
+where
+| ''axe''   | ''[[doc:user:geometry:user:axes|Axis]]'' | reflection axis which indicates the direction of the point reflection     |
+| ''ampl''  | ''float''                                | amplitude             |
+| ''disp''  | ''Vect3''                                | displacement vector   |
-===== Reflection symmetry operator =====
+===== Reflection/Symmetry Operator =====
-This operator is used to apply a reflection symmetry to a geometric entity, meshed or not. It is defined by a ''[[surfaces#plan|Plane]]'':
+This operator is used to apply a reflection symmetry to a geometric entity, meshed or not:
   op = OrthogonalSymmetryOperator(plane)
-  sideset(1).move(op)
+where
+| ''plane''   | ''[[surfaces#plan|Plane]]'' | reflection plane |
-===== Scaling operator =====
+===== Scaling Operator =====
-This operator is used to apply a scaling to a geometric entity, meshed or not. It is defined by its homothetic center (''Point'') and by the scaling factor ''fact'':
+This operator is used to apply a scaling to a geometric entity, meshed or not.
   op = ScalingOperator(pt0, fact)
-  sideset(1).move(op)
+where
+| ''pt0''   | ''Point'' | homothetic centre |
+| ''fact''   | ''float'' | scaling factor |