Skip to main content

oSP3D Script API 2024 R1

DistanceField Class Reference

Last update: 16.07.2025

represents a distance field for an unstructured grid More...

Public Member Functions

 DistanceField ()
 default constructor used for serialization
 
 DistanceField (::Structure database, number additional_space, number _grid_distance, size_t max_approx_grid_size, bool use_all_boundary_faces=true, bool do_not_warn=false)
 
::Structure exportData ()
 destructor More...
 
bool hasData () const
 

Static Public Member Functions

static number getElementSizeFromQuantile (Structure database, number quantile_value)
 

Detailed Description

represents a distance field for an unstructured grid

Constructor & Destructor Documentation

◆ DistanceField()

DistanceField ( ::Structure  database,
number  additional_space,
number  _grid_distance,
size_t  max_approx_grid_size,
bool  use_all_boundary_faces = true,
bool  do_not_warn = false 
)
Parameters
additional_spacedefines how much space must be added along each direction of the structure
_grid_distancedefines the grid point distance
max_approx_grid_sizethis is an approximate upper bound to the number of grid points, given that the grid point distance computed from the quantile value exceeds all bounds
use_all_boundary_facesif true, then the complete boundary is used. If false, then the boundary is determined by the reference node set
do_not_warnif true no warning will be created (quiet mode)

Member Function Documentation

◆ exportData()

::Structure exportData ( )

destructor

returns a copy of the internal distance field as a database

◆ hasData()

bool hasData ( ) const
Returns
true if the distance field contains data

Connect with Ansys