/[escript]/trunk/doc/user/pycad.tex
ViewVC logotype

Diff of /trunk/doc/user/pycad.tex

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 2371 by gross, Mon Apr 6 11:48:32 2009 UTC revision 2429 by gross, Tue May 19 10:04:54 2009 UTC
# Line 122  enclosed area, but gmsh will fail to cre Line 122  enclosed area, but gmsh will fail to cre
122  Some of the most commonly-used objects in {\it pycad} are listed here. For a more complete  Some of the most commonly-used objects in {\it pycad} are listed here. For a more complete
123  list see the full API documentation.  list see the full API documentation.
124    
125  \begin{classdesc}{Point}{x1, x2, x3}  \begin{classdesc}{Point}{x=0.,y=0.,z=0.\optional{,local_scale=1.}}
126  Create a point with from coordinates.  Create a point with from coordinates with local characteristic length \var{local_scale}
127  \end{classdesc}  \end{classdesc}
128    
129  \begin{classdesc}{Line}{point1, point2}  \begin{classdesc}{Line}{point1, point2}
130  Create a line with between starting and ending points.  Create a line with between starting and ending points.
131  \end{classdesc}  \end{classdesc}
132    \begin{methoddesc}[Line]{setElementDistribution}{n\optional{,progression=1\optional{,createBump=\False}}}
133    Defines the number of elements on the line. If set it overwrites the local length setting which would be applied. The progression factor \var{progression} defines the change of element size between naighboured elements. If \var{createBump} is set
134    progression is applied towards the center of the line.
135    \end{methoddesc}
136    \begin{methoddesc}[Line]{resetElementDistribution}{}
137    removes a previously set element distribution from the line.
138    \end{methoddesc}
139    \begin{methoddesc}[Line]{getElemenofDistribution}{}
140    Returns the element distribution as tuple of
141    number of elements, progression factor and bump flag. If
142    no element distribution is set None is returned.
143    \end{methoddesc}
144    
145    
146    \begin{classdesc}{Spline}{point0, point1, ...}
147    A spline curve defined by a list of points \var{point0}, \var{point1},....
148    \end{classdesc}
149    \begin{methoddesc}[Spline]{setElementDistribution}{n\optional{,progression=1\optional{,createBump=\False}}}
150    Defines the number of elements on the line. If set it overwrites the local length setting which would be applied. The progression factor \var{progression} defines the change of element size between naighboured elements. If \var{createBump} is set
151    progression is applied towards the center of the line.
152    \end{methoddesc}
153    \begin{methoddesc}[Spline]{resetElementDistribution}{}
154    removes a previously set element distribution from the line.
155    \end{methoddesc}
156    \begin{methoddesc}[Spline]{getElemenofDistribution}{}
157    Returns the element distribution as tuple of
158    number of elements, progression factor and bump flag. If
159    no element distribution is set None is returned.
160    \end{methoddesc}
161    
162    \begin{classdesc}{BSpline}{point0, point1, ...}
163    A B-spline curve defined by a list of points \var{point0}, \var{point1},....
164    \end{classdesc}
165    \begin{methoddesc}[BSpline]{setElementDistribution}{n\optional{,progression=1\optional{,createBump=\False}}}
166    Defines the number of elements on the line. If set it overwrites the local length setting which would be applied. The progression factor \var{progression} defines the change of element size between naighboured elements. If \var{createBump} is set
167    progression is applied towards the center of the line.
168    \end{methoddesc}
169    \begin{methoddesc}[BSpline]{resetElementDistribution}{}
170    removes a previously set element distribution from the line.
171    \end{methoddesc}
172    \begin{methoddesc}[BSpline]{getElemenofDistribution}{}
173    Returns the element distribution as tuple of
174    number of elements, progression factor and bump flag. If
175    no element distribution is set None is returned.
176    \end{methoddesc}
177    
178    \begin{classdesc}{BezierCurve}{point0, point1, ...}
179    A Brezier spline curve defined by a list of points \var{point0}, \var{point1},....
180    \end{classdesc}
181    \begin{methoddesc}[BezierCurve]{setElementDistribution}{n\optional{,progression=1\optional{,createBump=\False}}}
182    Defines the number of elements on the line. If set it overwrites the local length setting which would be applied. The progression factor \var{progression} defines the change of element size between naighboured elements. If \var{createBump} is set
183    progression is applied towards the center of the line.
184    \end{methoddesc}
185    \begin{methoddesc}[BezierCurve]{resetElementDistribution}{}
186    removes a previously set element distribution from the line.
187    \end{methoddesc}
188    \begin{methoddesc}[BezierCurve]{getElemenofDistribution}{}
189    Returns the element distribution as tuple of
190    number of elements, progression factor and bump flag. If
191    no element distribution is set None is returned.
192    \end{methoddesc}
193    
194  \begin{classdesc}{Curve}{point1, point2, ...}  \begin{classdesc}{Arc}{center_point, start_point, end_point}
195  Create a \code{Curve}, which is simply a list of points.  Create an arc by specifying a center for a circle and start and end points. An arc may subtend an angle of at most $\pi$ radians.
 \end{classdesc}  
   
 \begin{classdesc}{Spline}{curve}  
 Interpret a \code{Curve} using a spline.  
 \end{classdesc}  
   
 \begin{classdesc}{BSpline}{curve}  
 Interpret a \code{Curve} using a b-spline.  
 \end{classdesc}  
   
 \begin{classdesc}{BezierCurve}{curve}  
 Interpret a \code{Curve} using a Bezier curve.  
196  \end{classdesc}  \end{classdesc}
197    \begin{methoddesc}[Arc]{setElementDistribution}{n\optional{,progression=1\optional{,createBump=\False}}}
198    Defines the number of elements on the line. If set it overwrites the local length setting which would be applied. The progression factor \var{progression} defines the change of element size between naighboured elements. If \var{createBump} is set
199    progression is applied towards the center of the line.
200    \end{methoddesc}
201    \begin{methoddesc}[Arc]{resetElementDistribution}{}
202    removes a previously set element distribution from the line.
203    \end{methoddesc}
204    \begin{methoddesc}[Arc]{getElemenofDistribution}{}
205    Returns the element distribution as tuple of
206    number of elements, progression factor and bump flag. If
207    no element distribution is set None is returned.
208    \end{methoddesc}
209    
210  \begin{classdesc}{CurveLoop}{list}  \begin{classdesc}{CurveLoop}{list}
211  Create a closed \code{Curve} connecting the lines and/or points given in the \code{list}.  Create a closed curve from the \code{list}. of
212  \end{classdesc}  \class{Line}, \class{Arc}, \class{Spline}, \class{BSpline},
213    \class{BrezierSpline}.
 \begin{classdesc}{Arc}{center_point, start_point, end_point}  
 Create an arc by specifying a center for a circle and start and end points. An arc may subtend an angle of at most $\pi$ radians.  
214  \end{classdesc}  \end{classdesc}
215    
216  \begin{classdesc}{PlaneSurface}{loop, \optional{holes=[list]}}  \begin{classdesc}{PlaneSurface}{loop, \optional{holes=[list]}}
217  Create a surface for a 2-D mesh, which may have one or more holes.  Create a plane surface from a \class{CurveLoop}, which may have one or more holes
218    described by \var{list} of \class{CurveLoop}.
219  \end{classdesc}  \end{classdesc}
220    \begin{methoddesc}[PlaneSurface]{setRecombination}{max_deviation}
221    the mesh generator will try to recombine triangular elements
222    into quadrilateral elements. \var{max_deviation} (in radians) defines the
223    maximum deviation of any angle in the quadrilaterals from the right angle.  
224    Set \var{max_deviation}=\var{None} to remove recombination.
225    \end{methoddesc}
226    \begin{methoddesc}[PlaneSurface]{setTransfiniteMeshing}{\optional{orientation="Left"}}
227    applies 2D transfinite meshing to the surface.
228    \var{orientation} defines the orientation of triangles. Allowed values
229    are \var{``Left''}, \var{``Right''} or \var{``Alternate''}. The
230    boundary of the surface muist be defined by three or four lines where an
231    element distribution must be defined on all faces where opposite
232    faces uses the same element distribution. No holes must be present.
233    \end{methoddesc}
234    
235    
236    
237  \begin{classdesc}{RuledSurface}{list}  \begin{classdesc}{RuledSurface}{list}
238  Create a surface that can be interpolated using transfinite interpolation.  Create a surface that can be interpolated using transfinite interpolation.
239    \var{list} gives a list of three or four lines defining the boundary of the
240    surface.
241  \end{classdesc}  \end{classdesc}
242    \begin{methoddesc}[RuledSurface]{setRecombination}{max_deviation}
243    the mesh generator will try to recombine triangular elements
244    into quadrilateral elements. \var{max_deviation} (in radians) defines the
245    maximum deviation of any angle in the quadrilaterals from the right angle.  
246    Set \var{max_deviation}=\var{None} to remove recombination.
247    \end{methoddesc}
248    \begin{methoddesc}[RuledSurface]{setTransfiniteMeshing}{\optional{orientation="Left"}}
249    applies 2D transfinite meshing to the surface.
250    \var{orientation} defines the orientation of triangles. Allowed values
251    are \var{``Left''}, \var{``Right''} or \var{``Alternate''}. The
252    boundary of the surface muist be defined by three or four lines where an
253    element distribution must be defined on all faces where opposite
254    faces uses the same element distribution. No holes must be present.
255    \end{methoddesc}
256    
257    
258  \begin{classdesc}{SurfaceLoop}{list}  \begin{classdesc}{SurfaceLoop}{list}
259  Create a loop of 2D primitives, which defines the shell of a volume.  Create a loop of \class{PlaneSurface} or \class{RuledSurface}, which defines the shell of a volume.
260  \end{classdesc}  \end{classdesc}
261    
262  \begin{classdesc}{Volume}{loop, \optional{holes=[list]}}  \begin{classdesc}{Volume}{loop, \optional{holes=[list]}}
263  Create a volume for a 3-D mesh given a SurfaceLoop, which may have one or more holes.  Create a volume given a \class{SurfaceLoop}, which may have one or more holes
264    define by the list of \class{SurfaceLoop}.
265  \end{classdesc}  \end{classdesc}
266    
267  \begin{classdesc}{PropertySet}{list}  \begin{classdesc}{PropertySet}{list}

Legend:
Removed from v.2371  
changed lines
  Added in v.2429

  ViewVC Help
Powered by ViewVC 1.1.26