pyFormex manual
Up:
pyFormex Home Page
Next:
Preamble
pyFormex manual
Benedict Verhegghe
Release 0.8-a1
9 June 2009
Preamble
1. Introduction
1.1 What is pyFormex?
1.2 License and Disclaimer
1.3 Installation
1.3.1 Prerequisites
1.3.2 Downloading
1.3.3 Installation on Linux platforms
1.3.4 Installation on Windows platforms
1.4 Running pyFormex
1.5 Getting started with the pyFormex GUI
1.6 Quick Python tutorial
1.7 Quick NumPy tutorial
1.8 How to proceed from here
2. pyFormex tutorial
2.1 The pyFormex philosophy
2.2 Getting started
2.3 Creating geometrical models
2.3.1 The Formex data model
2.3.2 Creating a Formex
2.3.3 Drawing a Formex
2.3.4 Adding property numbers
2.3.5 Saving images
2.3.6 Information about a Formex
2.3.7 Changing the Formex
2.3.8 Converting a Formex to a Finite Element model
2.4 Assigning properties to geometry
2.4.1 General properties
2.4.2 Using the
set
and
setname
fields
2.4.3 Specialized property records
2.4.4 Node properties
2.4.5 Element properties
2.4.6 Property data classes
2.5 Exporting to finite element programs
3. The Canvas
3.1 Introduction
3.2 Drawing a Formex
3.3 Viewing the scene
3.4 Other canvas items
3.4.1 Actors
3.4.2 Marks
3.4.3 Decorations
3.5 Multiple viewports
4. The Graphical User Interface
4.1 Starting the GUI
4.2 Basic use of the GUI
4.3 The file menu
4.4 The viewport menu
4.5 Mouse interactions on the canvas
4.5.1 Rotate, pan and zoom
4.5.2 Interactive selection
4.6 Customizing the GUI
4.6.1 Changing the appearance of the GUI
4.6.2 Adding your scripts in a menu
4.6.3 Adding custom menus
5. Configuring pyFormex
5.1 pyFormex configuration files
5.2 Syntax of the configuration files
5.3 Configuration variables
6. pyFormex example scripts
6.1 Creating geometry
6.1.1 Creating the base module
6.1.2 Extending the base module
6.1.3 Full nearly planar pattern
6.1.4 Cylindrical stent structure
6.1.5 Parametric stent geometry
6.2 Operating on surface meshes
6.2.1 Unroll stent
7. pyFormex plugins
7.1 What are pyFormex plugins?
7.2 How to create a pyFormex plugin.
8. pyFormex -- reference manual
8.1
formex
-- General 3D geometry.
8.1.1 The Formex class
8.1.2 Formex class members
8.1.3 Basic access methods
8.1.4 Methods returning information
8.1.5 Methods returning string representations
8.1.6 Methods changing the instance data
8.1.7 Methods returning copies
8.1.8 Clipping methods
8.1.9 Affine transformations
8.1.10 Non-affine transformations
8.1.11 Topology changing transformations
8.1.12 Transformations that are limited to specific plexitudes.
8.1.13 Write to file, read from file
8.1.14 Non-member functions
8.2
coords
-- A structured collection of 3D coordinates.
8.2.1 Coords class: A structured collection of 3D coordinates.
8.2.2 Functions defined in the coords module
8.3
array
-- A collection of numerical array utilities.
8.4
script
-- Basic pyFormex script functions
8.4.1 Exit class: Exception raised to exit from a running script.
8.4.2 ExitAll class: Exception raised to exit pyFormex from a script.
8.4.3 ExitSeq class: Exception raised to exit from a sequence of scripts.
8.4.4 TimeOut class: Exception raised to timeout from a dialog widget.
8.4.5 Functions defined in the script module
8.5
draw
-- Create 3D graphical representations.
8.6
colors
-- Definition of some RGB colors and color conversion functions
8.7
connectivity
-- connectivity.py
8.7.1 Connectivity class: A class for handling element/node connectivity.
8.7.2 Functions defined in the connectivity module
8.8
simple
-- Predefined geometries with a simple shape.
8.9
project
-- project.py
8.9.1 Project class: A project is a persistent storage of a Python dictionary.
8.10
utils
-- A collection of miscellaneous utility functions.
8.10.1 NameSequence class: A class for autogenerating sequences of names.
8.10.2 Functions defined in the utils module
8.11
colorscale
-- Color mapping of a range of values.
8.11.1 ColorScale class: Mapping floating point values into colors.
8.11.2 ColorLegend class: A colorlegend is a colorscale divided in a number of subranges.
8.12
image
-- Saving OpenGL renderings to image files.
8.13
widgets
-- A collection of custom widgets used in the pyFormex GUI
8.13.1 Options class:
8.13.2 FileSelection class: A file selection dialog widget.
8.13.3 ProjectSelection class: A file selection dialog specialized for opnening projects.
8.13.4 SaveImageDialog class: A file selection dialog with extra fields.
8.13.5 ImageViewerDialog class:
8.13.6 AppearenceDialog class: A dialog for setting the GUI appearance.
8.13.7 DockedSelection class: A widget that is docked in the main window and contains a modeless
8.13.8 ModelessSelection class: A modeless dialog for selecting one or more items from a list.
8.13.9 Selection class: A dialog for selecting one or more items from a list.
8.13.10 InputItem class: A single input item, usually with a label in front.
8.13.11 InputInfo class: An unchangeable input item.
8.13.12 InputString class: A string input item.
8.13.13 InputText class: A scrollable text input item.
8.13.14 InputBool class: A boolean input item.
8.13.15 InputCombo class: A combobox InputItem.
8.13.16 InputRadio class: A radiobuttons InputItem.
8.13.17 InputPush class: A pushbuttons InputItem.
8.13.18 InputInteger class: An integer input item.
8.13.19 InputFloat class: An float input item.
8.13.20 InputSlider class: An integer input item using a slider.
8.13.21 InputFSlider class: A float input item using a slider.
8.13.22 InputColor class: A color input item.
8.13.23 InputDialog class: A dialog widget to set the value of one or more items.
8.13.24 NewInputDialog class: A dialog widget to set the value of one or more items.
8.13.25 TableModel class: A table model that represent data as a two-dimensional array of items.
8.13.26 Table class: A dialog widget to show two-dimensional arrays of items.
8.13.27 TableDialog class: A dialog widget to show two-dimensional arrays of items.
8.13.28 ButtonBox class:
8.13.29 ComboBox class:
8.13.30 BaseMenu class: A general menu class.
8.13.31 Menu class: A popup/pulldown menu.
8.13.32 MenuBar class: A menu bar allowing easy menu creation.
8.13.33 DAction class: A DAction is a QAction that emits a signal with a string parameter.
8.13.34 ActionList class: Menu and toolbar with named actions.
8.13.35 Functions defined in the widgets module
8.14
curve
-- Definition of curves in pyFormex.
8.14.1 Curve class: Base class for curve type classes.
8.14.2 PolyLine class: A class representing a series of straight line segments.
8.14.3 Polygon class: A Polygon is a closed PolyLine.
8.14.4 BezierSpline class: A class representing a Bezier spline curve.
8.14.5 CardinalSpline class: A class representing a cardinal spline.
8.14.6 CardinalSpline2 class: A class representing a cardinal spline.
8.14.7 NaturalSpline class: A class representing a natural spline.
8.15
fe
-- Finite Element Models in pyFormex.
8.15.1 Model class: Contains all FE model data.
8.15.2 Functions defined in the fe module
8.16
inertia
-- inertia.py
8.17
isopar
-- Isoparametric transformations
8.17.1 Isopar class: A class representing an isoparametric transformation
8.17.2 Functions defined in the isopar module
8.18
lima
-- Lindenmayer Systems
8.18.1 Lima class: A class for operations on Lindenmayer Systems.
8.18.2 Functions defined in the lima module
8.19
mesh
-- mesh.py
8.19.1 Mesh class: A mesh is a discrete geometrical model consisting of nodes and elements.
8.19.2 Functions defined in the mesh module
8.20
properties
-- General framework for attributing properties to geometrical elements.
8.20.1 Database class: A class for storing properties in a database.
8.20.2 MaterialDB class: A class for storing material properties.
8.20.3 SectionDB class: A class for storing section properties.
8.20.4 ElemSection class: Properties related to the section of an element.
8.20.5 ElemLoad class: Distributed loading on an element.
8.20.6 CoordSystem class: A class for storing coordinate systems.
8.20.7 Amplitude class: A class for storing an amplitude.
8.20.8 PropertyDB class: A database class for all properties.
8.20.9 Functions defined in the properties module
8.21
section2d
-- Some functions operating on 2D structures.
8.21.1 planeSection class: A class describing a general 2D section.
8.21.2 Functions defined in the section2d module
8.22
surface
-- Import/Export Formex structures to/from stl format.
8.22.1 TriSurface class: A class for handling triangulated 3D surfaces.
8.22.2 Functions defined in the surface module
8.23
turtle
--
8.24
olist
-- Some convenient shortcuts for common list operations.
8.25
mydict
--
8.25.1 Dict class: A Python dictionary with default values and attribute syntax.
8.25.2 CDict class: A cascading Dict: properties not in Dict are searched in all Dicts.
8.25.3 Functions defined in the mydict module
8.26
odict
-- A dictionary that keeps the keys in order of insertion.
8.26.1 ODict class: An ordered dictionary.
8.26.2 KeyList class: A named item list.
9. pyFormex FAQ 'n TRICKS
9.1 FAQ
9.2 TRICKS
A. GNU GENERAL PUBLIC LICENSE
How to Apply These Terms to Your New Programs
Index
About this document ...
pyFormex manual
Up:
pyFormex Home Page
Next:
Preamble
Release 0.8-a1, documentation updated on 9 June 2009.