Version: 9.16.0
Home
Loading...
Searching...
No Matches

Field on Geometry. More...

Public Member Functions

 __init__ (self, *args)
 
 getShape (self)
 Returns the shape the field lies on.
 
 getName (self)
 Returns the field name.
 
 getType (self)
 Returns type of field data as integer [0-3].
 
 getTypeEnum (self)
 Returns type of field data: one of GEOM.FDT_Bool, GEOM.FDT_Int, GEOM.FDT_Double, GEOM.FDT_String.
 
 getDimension (self)
 Returns dimension of the shape the field lies on: 0 - VERTEX, 1 - EDGE, 2 - FACE, 3 - SOLID, -1 - whole shape.
 
 getComponents (self)
 Returns names of components.
 
 addStep (self, step, stamp, values)
 Adds a time step to the field.
 
 removeStep (self, step)
 Remove a time step from the field.
 
 countSteps (self)
 Returns number of time steps in the field.
 
 getSteps (self)
 Returns a list of time step IDs in the field.
 
 getStep (self, step)
 Returns a time step by its ID.
 
 getStamp (self, step)
 Returns the time of the field step.
 
 setStamp (self, step, stamp)
 Changes the time of the field step.
 
 getValues (self, step)
 Returns values of the field step.
 
 setValues (self, step, values)
 Changes values of the field step.
 

Data Fields

 field
 

Detailed Description

Field on Geometry.

Constructor & Destructor Documentation

◆ __init__()

__init__ (   self,
*  args 
)

Member Function Documentation

◆ getShape()

getShape (   self)

Returns the shape the field lies on.

References geomField.field.

◆ getName()

getName (   self)

Returns the field name.

References geomField.field.

◆ getType()

getType (   self)

Returns type of field data as integer [0-3].

References geomBuilder.EnumToLong(), and geomField.field.

◆ getTypeEnum()

getTypeEnum (   self)

Returns type of field data: one of GEOM.FDT_Bool, GEOM.FDT_Int, GEOM.FDT_Double, GEOM.FDT_String.

References geomField.field.

◆ getDimension()

getDimension (   self)

Returns dimension of the shape the field lies on: 0 - VERTEX, 1 - EDGE, 2 - FACE, 3 - SOLID, -1 - whole shape.

References geomField.field.

◆ getComponents()

getComponents (   self)

Returns names of components.

References geomField.field.

◆ addStep()

addStep (   self,
  step,
  stamp,
  values 
)

Adds a time step to the field.

Parameters
stepthe time step number further used as the step identifier
stampthe time step time
valuesthe values of the time step

References geomField.field, and geomField.setValues().

◆ removeStep()

removeStep (   self,
  step 
)

Remove a time step from the field.

References geomField.field.

◆ countSteps()

countSteps (   self)

Returns number of time steps in the field.

References geomField.field.

◆ getSteps()

getSteps (   self)

Returns a list of time step IDs in the field.

References geomField.field.

◆ getStep()

getStep (   self,
  step 
)

Returns a time step by its ID.

References geomField.field.

◆ getStamp()

getStamp (   self,
  step 
)

Returns the time of the field step.

References geomField.getStep().

◆ setStamp()

setStamp (   self,
  step,
  stamp 
)

Changes the time of the field step.

References geomField.getStep().

◆ getValues()

getValues (   self,
  step 
)

Returns values of the field step.

References geomField.getStep().

◆ setValues()

setValues (   self,
  step,
  values 
)

Changes values of the field step.

References geomField.field, geomField.getStep(), and geomField.getTypeEnum().

Field Documentation

◆ field

field