API Reference: STEPS-CUBIT Geometry Preparation Toolkit (Independent)

Shadow Classes

Functions

getSelectedVolumes()[source]

Return the CUBIT indices of the selected volumes.

Parameters:

None

Return:

cubit_ids

getSelectedSurfaces()[source]

Return the CUBIT indices of the selected surfaces.

Parameters:

None

Return:

cubit_ids

getSelectedNodes()[source]

Return the CUBIT indices of the selected vertex nodes.

Parameters:

None

Return:

cubit_ids

getSelectedTets()[source]

Return the CUBIT indices of the selected tetrahedrons.

Parameters:

None

Return:

cubit_ids

getSelectedTris()[source]

Return the CUBIT indices of the selected triangles.

Parameters:

None

Return:

cubit_ids

selectedVolumesAsComp(comp_name, mesh, vsys)[source]

Create a shadow compartment using selected volumes.

Parameters:

  • comp_name Name of the compartment

  • mesh ShadowMesh object

  • vsys List of STEPS volume system ids for the compartment

Return:

ShadowComp object

selectedSurfacesAsPatch(patch_name, mesh, ssys, icomp, ocomp=None)[source]

Create a shadow patch using selected surfaces.

Parameters:

  • patch_name Name of the patch

  • mesh ShadowMesh object

  • ssys List of STEPS volume system ids for the compartment

  • icomp ShadowComp object as inner compartment

  • ocomp ShadowComp object as outer compartment, None by default

Return:

ShadowPatch object

selectedTetsAsComp(comp_name, mesh, vsys)[source]

Create a shadow compartment using selected tetraedrons.

Parameters:

  • comp_name Name of the compartment

  • mesh ShadowMesh object

  • vsys List of STEPS volume system ids for the compartment

Return:

ShadowComp object

selectedTrisAsPatch(patch_name, mesh, ssys, icomp, ocomp=None)[source]

Create a shadow patch using selected triangles.

Parameters:

  • patch_name Name of the patch

  • mesh ShadowMesh object

  • ssys List of STEPS volume system ids for the compartment

  • icomp ShadowComp object as inner compartment

  • ocomp ShadowComp object as outer compartment, None by default

Return:

ShadowPatch object

selectedNodesAsROI(roi_name, mesh)[source]

Store the selected nodes as Region of Interest in the ShadowMesh object.

Parameters:

  • roi_name Name of the ROI

  • mesh ShadowMesh object

Return:

None

selectedTetsAsROI(roi_name, mesh)[source]

Store the selected terrahedrons as Region of Interest in the ShadowMesh object.

Parameters:

  • roi_name Name of the ROI

  • mesh ShadowMesh object

Return:

None

selectedTrisAsROI(roi_name, mesh)[source]

Store the selected triangles as Region of Interest in the ShadowMesh object.

Parameters:

  • roi_name Name of the ROI

  • mesh ShadowMesh object

Return:

None

getNodesBoundInSelectedVols(target_list)[source]

Return nodes bound in selected CUBIT volumes.

Parameters:

  • target_list List of indices of target nodes

Return:

List of indices of nodes bound by the volumes

getTetsBoundInSelectedVols(target_list)[source]

Return tetraherons bound in selected CUBIT volumes.

Parameters:

  • target_list List of indices of target tetrahedrons

Return:

List of indices of tetrahedrons bound by the volumes

getTrisBoundInSelectedVols(target_list)[source]

Return triangles bound in selected CUBIT volumes.

Parameters:

  • target_list List of indices of target triangles

Return:

List of indices of triangles bound by the volumes

boundTetsAsComp(target_list, comp_name, mesh, vsys)[source]

Create a shadow compartment using tetraedrons bound in selected volumes.

Parameters:

  • target_list List of indices of target tetrahedrons

  • comp_name Name of the compartment

  • mesh ShadowMesh object

  • vsys List of STEPS volume system ids for the compartment

Return:

ShadowComp object

boundTrisAsPatch(target_list, patch_name, mesh, ssys, icomp, ocomp=None)[source]

Create a shadow patch using triangles bound in selected volumes.

Parameters:

  • target_list List of indices of target triangles

  • patch_name Name of the patch

  • mesh ShadowMesh object

  • ssys List of STEPS volume system ids for the compartment

  • icomp ShadowComp object as inner compartment

  • vocomp ShadowComp object as outer compartment, None by default

Return:

ShadowPatch object

boundNodesAsROI(target_list, roi_name, mesh)[source]

Store nodes bound in selected volumes as Region of Interest in the shadow mesh.

Parameters:

  • target_list List of indices of target nodes

  • roi_name Name of the ROI

  • mesh ShadowMesh object

Return:

None

boundTetsAsROI(target_list, roi_name, mesh)[source]

Store tetrahedrons bound in selected volumes as Region of Interest in the shadow mesh.

Parameters:

  • target_list List of indices of target tetrahedrons

  • roi_name Name of the ROI

  • mesh ShadowMesh object

Return:

None

boundTrisAsROI(target_list, roi_name, mesh)[source]

Store triangles bound in selected volumes as Region of Interest in the shadow mesh.

Parameters:

  • target_list List of indices of target triangles

  • roi_name Name of the ROI

  • mesh ShadowMesh object

Return:

None

drawROI(mesh, roi_name)[source]

Draw elements stored in ROI database with id roi_name.

Parameters:

  • mesh ShadowMesh object

  • roi_name Name of the ROI

Return:

None

highlightROI(mesh, roi_name)[source]

Highlight elements stored in ROI database with id roi_name.

Parameters:

  • mesh ShadowMesh object

  • roi_name Name of the ROI

Return:

None

class ShadowMesh[source]

Shadow class for STEPS mesh.

Parameters:

None

addComp(comp)[source]

Add a compartment to the mesh. Note: Internal method, should use Comp(name, mesh, indices, vsys) instead.

addPatch(patch)[source]

Add a patch to the mesh. Note: Internal method, should use Patch(name, mesh, indices, ssys, icomp, ocomp) instead.

addROI(roi_name, type, indices)[source]

Add Region of Interest Data.

Parameters:

  • roi_name Name of the region of interest

  • type Type of the elements

  • indices Indices of the elements

Return:

None

removeROI(roi_name)[source]

Remove Region of Interest Data.

Parameters:

  • roi_name Name of the region of interest

Return:

None

exportTo(file_name)[source]

Export data to a given file.

Parameters:

  • file File for the exporting

Return:

None

static importFrom(file_name)[source]

Import data from a given file and create a ShadowMesh object according to the data.

Parameters:

  • file File for the importing

Return:

ShadowMesh object

writeToTetmesh(tetmesh, node_proxy, tet_proxy, tri_proxy)[source]

Write data to STEPS Tetmesh object.

Parameters:

  • tetmesh STEPS Tetmesh object

  • node_proxy ElementProxy object for nodes

  • tet_proxy ElementProxy object for tetrahedrons

  • tri_proxy ElementProxy object for triangles

Return:

ShadowMesh object

class ShadowComp(name, mesh, indices, vsyss)[source]

Shadow class for STEPS compartment.

Parameters:

  • name Name of the compartment

  • mesh ShadowMesh object

  • indices Indices of the tetrahedrons in the compartment

  • vsyss List of ids of the associated volume systems

exportTo(file)[source]

Export data to a given file.

Parameters:

  • file File for the exporting

Return:

None

static importFrom(mesh, file)[source]

Import data from a given file and create a ShadowComp object according to the data.

Parameters:

  • mesh Associated ShadowMesh file

  • file File for the importing

Return:

ShadowComp object

class ShadowPatch(name, mesh, indices, ssyss, icomp, ocomp=None)[source]

Shadow class for STEPS patch.

Parameters: * name Name of the patch * mesh ShadowMesh object * indices Indices of the triangles in the patch * ssyss List of ids of the associated surface systems * icomp Inner ShadowComp object * ocomp Outer ShadowComp object

exportTo(file)[source]

Export data to a given file.

Parameters: * file File for the exporting

Return: None

static importFrom(mesh, file)[source]

Import data from a given file and create a ShadowPatch object according to the data.

Parameters: * mesh Associated ShadowMesh file * file File for the importing

Return: ShadowPatch object

toStr(e_list)[source]

Convert entities list to a text string.

Parameters:

  • e_list entity index list

Return:

String of the entities separated by comma

drawComp(mesh, comp_id)[source]

Draw the compartment.

Parameters:

  • mesh ShadowMesh object

  • comp_id ID of the ShadowComp object

Return:

None

drawPatch(mesh, patch_id)[source]

Draw the patch.

Parameters:

  • mesh ShadowMesh object

  • patch_id ID of the ShadowPatch object

Return:

None

highlightComp(mesh, comp_id)[source]

Highlight the compartment.

Parameters:

  • mesh ShadowMesh object

  • comp_id ID of the ShadowComp object

Return:

None

highlightPatch(mesh, patch_id)[source]

Highlight the patch.

Parameters:

  • mesh ShadowMesh object

  • patch_id ID of the ShadowPatch object

Return:

None