Volume
Volume of the geometry defined by faces
Fields Summary
- Field
- Description
- actualMeshGenerator
- Actual Mesh Generator used by Flux to mesh the current volume
- color
- Volume Color
- meshGenerator
- Mesh generator defining the mesh in the volume
- region
- Volume Region holding the volume
- relaxation
- Relaxation of the mesh in the volume
- shell
- Bordering faces of the volume
- visibility
- Volume Visibility
Methods Summary
- Method
- Description
- assignMeshGenerator
- Assign mesh generator to volumes (modification mode)
- assignRegion
- Assign regions to volumes (modification mode)
- assignRelaxVolume
- Assign relaxation to volumes
- propagateVolume
- Propagate volumes
- propagateVolumes
- Propagate volumes
- setInvisible
- Set invisible selected volumes
- setVisible
- Set visible selected volumes
Fields Details
- actualMeshGenerator
- actualMeshGenerator : Actual Mesh Generator used by Flux to mesh the current volume - [1..1] MeshGenerator
- color
- color : Volume Color - [1..1] Color
- meshGenerator
- meshGenerator : Mesh generator defining the mesh in the volume - [0..1] MeshGenerator
- region
- region : Volume Region holding the volume - [0..1] RegionVolume
- relaxation
- relaxation : Relaxation of the mesh in the volume - [0..1] RelaxVolume
- shell
- shell : Bordering faces of the volume - [2..N] Face
- visibility
- visibility : Volume Visibility - [1..1] Visibility
Method Details
- assignMeshGenerator
-
-
Syntax
assignMeshGenerator(meshGenerator)
-
Parameters
- meshGenerator : Mesh Generator to assign to Volumes - [0..1] MeshGenerator
-
Returns
No return value
-
- assignRegion
-
-
Syntax
assignRegion(region)
-
Parameters
- region : Region Volume to assign to Volumes - [0..1] RegionVolume
-
Returns
No return value
-
- assignRelaxVolume
-
-
Syntax
assignRelaxVolume(relaxvolume)
-
Parameters
- relaxvolume : Relaxation to assign to volumes - [0..1] RelaxVolume
-
Returns
No return value
-
- propagateVolume
-
-
Syntax
results = propagateVolume(transformation, repetionNumber, buildingOption, regionPropagation, regionPeriodicity, regionSuffix)
-
Parameters
- transformation : Transformation for propagation - [1..1] Transf
- repetionNumber : Number of times to apply the transformation - [1..1] Integer
-
buildingOption : Building options for propagation - [1..1] Enumeration
Potential values :
- Lines
- Volumes
- VolumesWithMeshGenerator
-
regionPropagation : Regions propagation - [1..1] Enumeration
Potential values :
- None
- Same
- Increment
- Periodicity
- regionPeriodicity : Periodicity for regions propagation - [0..1] Integer
- regionSuffix : Suffix for region name - [0..1] String
-
Returns
- points Enumeration : points - [0..N] Point
- stateOfPoints : state of points - [0..N] Integer
- lines Enumeration : lines - [0..N] Line
- stateOfLines : state of lines - [0..N] Integer
- faces Enumeration : faces - [0..N] Face
- stateOfFaces : state of faces - [0..N] Integer
- volumes Enumeration : volumes - [0..N] Volume
- stateOfVolumes : state of volumes - [0..N] Integer
-
- propagateVolumes
-
-
Syntax
propagateVolumes(transformation, repetionNumber, buildingOption)
-
Parameters
- transformation : Transformation for propagation - [1..1] Transf
- repetionNumber : Number of times to apply the transformation - [1..1] Integer
-
buildingOption : Building options for propagation - [1..1] Enumeration
Potential values :
- Lines
- Volumes
-
Returns
No return value
-
- setInvisible
-
-
Syntax
setInvisible()
-
Parameters
No parameter
-
Returns
No return value
-
- setVisible
-
-
Syntax
setVisible()
-
Parameters
No parameter
-
Returns
No return value
-