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

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

Parent Directory | Revision Log | View Patch Patch

-revision 2716 by jfenwick,
Wed Sep 30 01:46:31 2009 UTC
+revision 2717 by gross,
Wed Oct 14 03:41:20 2009 UTC
 Line 290 
 triangles used to define the surfaces as
  The example script of the cube is included with the software in
  \file{brick.py} in the \ExampleDirectory.
+ \section{Alternative File Formats}
+ \code{pycad} supports other file formats in including
+ I-DEAS universal file, VRML, Nastran and STL. The following example shows how
+ to generate the STL file \file{brick.stl}:
+ \begin{python}
+ from esys.pycad.gmsh import Design
+ des=Design(dim=3, element_size = 0.1, keep_files=True)
+ des.addItems(v, top, bottom, back, front, left , right)
+ des.setFileFormat(des.STL)
+ des.setMeshFileName("brick.stl")
+ des.generate()
+ \end{python}
+ The example script of the cube is included with the software in
+ \file{brick_stl.py} in the \ExampleDirectory.
  \begin{figure}
  \centerline{\includegraphics[width=\figwidth]{figures/refine1}}
  \caption{Local refinement at the origin by
-Line 592 
 The argument \var{order} defines the ele
+Line 610 
 The argument \var{order} defines the ele
  \end{classdesc}
+ \begin{memberdesc}[Design]{GMSH}
+ gmsh file format~\cite{GMSH}.
+ \end{memberdesc}
+ \begin{memberdesc}[Design]{IDEAS}
+ I-DEAS universal file format~\cite{IDEAS}.
+ \end{memberdesc}
+ \begin{memberdesc}[Design]{VRML}
+ VRML file format, \cite{VRML}.
+ \end{memberdesc}
+ \begin{memberdesc}[Design]{STL}
+ STL file format~\cite{STL}.
+ \end{memberdesc}
+ \begin{memberdesc}[Design]{NASTRAN}
+ NASTRAN  bulk data format~\cite{NASTRAN}.
+ \end{memberdesc}
+ \begin{memberdesc}[Design]{MEDIT}
+ Medit file format~\cite{MEDIT}.
+ \end{memberdesc}
+ \begin{memberdesc}[Design]{CGNS}
+ CGNS file format~\cite{CGNS}.
+ \end{memberdesc}
+ \begin{memberdesc}[Design]{PLOT3D}
+ Plot3D file format~\cite{PLOT3D}.
+ \end{memberdesc}
+ \begin{memberdesc}[Design]{DIFFPACK}
+ Diffpack 3D file format~\cite{DIFFPACK}.
+ \end{memberdesc}
+ \begin{memberdesc}[Design]{DELAUNAY}
+ the gmsh Delauny triangulator.
+ \end{memberdesc}
+ \begin{memberdesc}[Design]{TETGEN}
+ the TetGen~\cite{TETGEN} triangulator.
+ \end{memberdesc}
+ \begin{memberdesc}[Design]{NETGEN}
+ the NETGEN~\cite{NETGEN} triangulator.
+ \end{memberdesc}
+ \begin{methoddesc}[Design]{generate}{}
+ generates the mesh file. The data are are written to the file \var{Design.getMeshFileName}.
+ \end{methoddesc}
  \begin{methoddesc}[Design]{setDim}{\optional{dim=3}}
  sets the spatial dimension which needs to be $1$, $2$ or $3$.
  \end{methoddesc}
-Line 608 
 sets the element order which needs to be
+Line 679 
 sets the element order which needs to be
  returns the element order.
  \end{methoddesc}
  \begin{methoddesc}[Design]{setElementSize}{\optional{element_size=1}}
  set the global element size. The local element size at a point is defined as
  the global element size multiplied by the local scale. The element size must be positive.
-Line 619 
 the global element size multiplied by th
+Line 689 
 the global element size multiplied by th
  returns the global element size.
  \end{methoddesc}
- \begin{memberdesc}[Design]{DELAUNAY}
- the gmsh Delauny triangulator.
- \end{memberdesc}
- \begin{memberdesc}[Design]{TETGEN}
- the TetGen~\cite{TETGEN} triangulator.
- \end{memberdesc}
- \begin{memberdesc}[Design]{NETGEN}
- the NETGEN~\cite{NETGEN} triangulator.
- \end{memberdesc}
  \begin{methoddesc}[Design]{setKeepFilesOn}{}
  work files are kept at the end of the generation.
-Line 653 
 returns the name of the file for the gms
+Line 713 
 returns the name of the file for the gms
  \begin{methoddesc}[Design]{setMeshFileName}{\optional{name=None}}
- sets the name for the gmsh  mesh file. if no name is given a name with extension "msh" is generated.
+ sets the name for the mesh file. if no name is given a name is generated.
+ The format is set by \var{Design.setFileFormat}.
  \end{methoddesc}
  \begin{methoddesc}[Design]{getMeshFileName}{}
- returns the name of the file for the gmsh msh
+ returns the name of the mesh file
  \end{methoddesc}
-Line 666 
 adds the tuple of var{items}. An item ca
+Line 727 
 adds the tuple of var{items}. An item ca
  \warning{If a \PropertySet is added as an item added object that are not
  part of a \PropertySet are not considered in the messing.
  }
  \end{methoddesc}
  \begin{methoddesc}[Design]{getItems}{}
-Line 680 
 resets the items in design
+Line 740 
 resets the items in design
  \begin{methoddesc}[Design]{getMeshHandler}{}
  returns a handle to the mesh. The call of this method generates the mesh from the geometry and
  returns a mechanism to access the mesh data. In the current implementation this
- method returns a file name for a gmsh file containing the mesh data.
+ method returns a file name for a file containing the mesh data.
  \end{methoddesc}
  \begin{methoddesc}[Design]{getScriptString}{}
-Line 701 
 or \var{Design.NETGEN}. By default \var{
+Line 761 
 or \var{Design.NETGEN}. By default \var{
  \begin{methoddesc}[Design]{getTagMap}{}
  returns a \class{TagMap} to map the name \class{PropertySet} in the class to tag numbers generated by gmsh.
  \end{methoddesc}
+ \begin{methoddesc}[Design]{setFileFormat}{\optional{format=\var{Design.GMSH}}}
+ set the file format. \var{format} must be one of the values
+ \var{Design.GMSH},
+ \var{Design.IDEAS},
+ \var{Design.VRML},
+ \var{Design.STL},
+ \var{Design.NASTRAN},
+ \var{Design.MEDIT},
+ \var{Design.CGNS},
+ \var{Design.PLOT3D} or
+ \var{Design.DIFFPACK}.
+ \end{methoddesc}
+ \begin{methoddesc}[Design]{sgetFileFormat}{}
+ returns the file format.
+ \end{methoddesc}

 Legend:



Removed from v.2716
 


changed lines


 
Added in v.2717
 Legend:



Removed from v.2716
 


changed lines


 
Added in v.2717
-Removed from v.2716
+Added in v.2717

	ViewVC Help
Powered by ViewVC 1.1.26