Defines a surface object that mostly parallels Cubit's RefFace class. More...

Inheritance diagram for Surface:

Public Member Functions
	area (self)
	Get area of the Surface.

	closest_point_along_vector (self, location, along_vector)
	Get the nearest point on the Surface to point specified along the specified vector.

	closest_point_trimmed (self, location)
	Get the nearest point on the Surface to point specified.

	color (self)
	Get the color of the surface.

	dihedral_angle (self, other, fraction)
	Get the dihedral angle between this surface and another surface at a fraction along the shared curve between them :type other: :py:class:`Surface`

	get_param_range_U (self)
	Get range of u for the Surface.

	get_param_range_V (self)
	Get range of v for the Surface.

	is_cylindrical (self)
	Get whether the Surface is cylindrical or not.

	is_planar (self)
	Get whether the Surface is planar or not.

	normal_at (self, location)
	Get the normal at a particular point on the Surface.

	ordered_loops (self)
	Get the ordered loops of the Surface.

	point_containment (self, point_in)
	Get whether a point is on or off of the Surface.

	position_from_u_v (self, u, v)
	Get the Cartesian coordinates from the uv coordinates on the Surface.

	principal_curvatures (self, point)
	Get the principal curvatures of the Surface.

	set_color (self, value)
	Set the color of the surface.

	u_v_from_position (self, location)
	Get the uv coordinates from the supplied Cartesian coordinates on the Surface.

Public Member Functions inherited from GeomEntity
	bodies (self)
	Retrieve bodies contained within the geometry entity.

	curves (self)
	Retrieve curves (edges) associated with the geometry entity.

	dimension (self)
	Get the topological dimension of the geometry entity.

	entity_name (self)
	Retrieve the primary name of the geometry entity.

	entity_names (self)
	Retrieve all names assigned to the geometry entity.

	is_meshed (self)
	Returns the current mesh state of the GeomEntity.

	is_transparent (self)
	Get the transparency state of the geometry entity.

	is_visible (self)
	Get the visibility state of the geometry entity.

	mesh (self)
	Generates mesh on a GeomEntity and verifies meshing status.

	num_names (self)
	Get the count of names assigned to the geometry entity.

	remove_entity_name (self, name)
	Remove a specific name from the geometry entity.

	remove_entity_names (self)
	Remove all non-default names from the geometry entity.

	remove_mesh (self)
	Remove any mesh associated with the geometry entity.

	set_entity_name (self, name)
	Assign a name to the geometry entity.

	set_transparent (self, transparency_flag)
	Set the transparency state of the geometry entity.

	set_visible (self, visibility_flag)
	Set and verify the visibility state of the geometry entity.

	smooth (self)
	Smooths the mesh on a GeomEntity to improve element quality.

	surfaces (self)
	Retrieve surfaces associated with the geometry entity.

	vertices (self)
	Retrieve vertices (points) associated with the geometry entity.

	volumes (self)
	Retrieve volumes associated with the geometry entity.

Public Member Functions inherited from Entity
	bounding_box (self)
	Returns the axis-aligned bounding box of the Entity.

	center_point (self)
	Returns the geometric center point of the Entity.

	id (self)
	Retrieves the unique identifier of the Entity.

Detailed Description

Defines a surface object that mostly parallels Cubit's RefFace class.

Member Function Documentation

◆ area()

area ( self )

Get area of the Surface.

    .. code-block:: python

area = surface.area()

   @n return type of :  float

Returns: The area of the Surface.

◆ closest_point_along_vector()

closest_point_along_vector	(	self,
		location,
		along_vector )

Get the nearest point on the Surface to point specified along the specified vector.

      .. code-block:: python

nearest = surface.closest_point_along_vector([0,0,0], [1,1,1])

     @n type of location:  std::array< double,3 >, in

Parameters

location A vector containing three values that are the coordinates of a point.

return type of : std:: array< double,3 >

Returns: A vector (or list) of doubles representing values of nearest point as follows:; 0 x coordinate; 1 y coordinate; 2 z coordinate

◆ closest_point_trimmed()

closest_point_trimmed	(		self,
			location )

Get the nearest point on the Surface to point specified.

      .. code-block:: python

nearest = surface.closest_point_trimmed([0,0,0])

     @n type of location:  std::array< double,3 >, in

Parameters

location A vector containing three values that are the coordinates of a point.

return type of : std:: array< double,3 >

Returns: A vector (or list) of doubles representing values of nearest point as follows:; 0 x coordinate; 1 y coordinate; 2 z coordinate

◆ color()

color ( self )

Get the color of the surface.

    .. code-block:: python

col = surface.color()

   @n return type of : std:: array< double,4 >

Returns: The color value associated with the surface's current color.

◆ dihedral_angle()

dihedral_angle	(	self,
		other,
		fraction )

Get the dihedral angle between this surface and another surface at a fraction along the shared curve between them :type other: :py:class:Surface

Parameters

other	The other surface object used to form the dihedral angle :type fraction: float
fraction	The fraction along the shared curve at which to calculate the dihedral angle (0.0 – 1.0) :rtype: float

Returns: the dihedral angle between the surfaces, in radians

◆ get_param_range_U()

get_param_range_U ( self )

Get range of u for the Surface.

          .. code-block:: python

bounds = surface.get_param_range_U()

         @n return type of : std:: array< double,2 >

Returns: The curvature values:; 0 The lowest value in the u direction; 1 The highest value in the u direction

◆ get_param_range_V()

get_param_range_V ( self )

Get range of v for the Surface.

          .. code-block:: python

lower_bound, upper_bound = surface.get_param_range_V()

         @n return type of : std:: array< double,2 >

Returns: The curvature values:; 0 The lowest value in the v direction; 1 The highest value in the v direction

◆ is_cylindrical()

is_cylindrical ( self )

Get whether the Surface is cylindrical or not.

    .. code-block:: python

cyl = surface.is_cylindrical()

   @n return type of :  boolean

Returns: Whether the Surface is cylindrical or not.

◆ is_planar()

is_planar ( self )

Get whether the Surface is planar or not.

    .. code-block:: python

planar = surface.is_planar()

   @n return type of :  boolean

Returns: Whether the Surface is planar or not.

◆ normal_at()

normal_at	(		self,
			location )

Get the normal at a particular point on the Surface.

      .. code-block:: python

norm = surface.normal_at([0,0,0])

     @n type of location:  std::array< double,3 >, in

Parameters

location A vector containing three values that are the coordinates of a point.

return type of : std:: array< double,3 >

Returns: A vector (or list) of doubles representing values of normal vector as follows:; 0 x value; 1 y value; 2 z value

◆ ordered_loops()

ordered_loops ( self )

Get the ordered loops of the Surface.

      .. code-block:: python

loops = surface.ordered_loops()

     @n return type of : std::vector< std::vector< CubitInterface::Curve,std::allocator< CubitInterface::Curve > >,std::allocator< std::vector< CubitInterface::Curve,std::allocator< CubitInterface:: Curve > > > >

Returns: A vector of vectors (or list of lists) of Curves in loops:

0, 0 - loop 1 curve 1

0, 1 - loop 1 curve 2

1, 0 - loop 2 curve 1

Returns: etc...

◆ point_containment()

point_containment	(		self,
			point_in )

Get whether a point is on or off of the Surface.

    .. code-block:: python

on_off = surface.point_containment([0,0,0])

   @n type of point_in:  std::array< double,3 >, in

Parameters

point_in A vector containing three values that are the coordinates of a point.

return type of : int

Returns: A python boolean representing whether the point is off (0) or on (1) the Surface.

◆ position_from_u_v()

position_from_u_v	(	self,
		u,
		v )

Get the Cartesian coordinates from the uv coordinates on the Surface.

      .. code-block:: python

pos = surface.position_from_u_v(0, 0)

     @n type of u:  float, in

Parameters

u	The u parameter type of v: float, in
v	The v parameter return type of : std:: array< double,3 >

Returns: The Cartesian coordinates of the supplied uv coordinates as a vector:; 0 x coordinate; 1 y coordinate; 2 z coordinate

◆ principal_curvatures()

principal_curvatures	(		self,
			point )

Get the principal curvatures of the Surface.

      .. code-block:: python

curvatures = surface.principal_curvatures([0,0,0])

     @n type of point:  std::array< double,3 >, in

Parameters

point A tuple containing 2 values that are the curvature in the principle u and v directions on the surface

return type of : std:: array< double,2 >

Returns: A list of two floats representing the curvatures.; 0 curvature 1; 1 curvature 2

◆ set_color()

set_color	(		self,
			value )

Set the color of the surface.

    .. code-block:: python

surface.set_color(0)

   @n type of value:  std::array< double,4 >, in

Parameters

value The color value that the surface will have.

◆ u_v_from_position()

u_v_from_position	(		self,
			location )

Get the uv coordinates from the supplied Cartesian coordinates on the Surface.

      .. code-block:: python

uv = surface.position_from_u_v([0,0,0])

     @n type of location:  std::array< double,3 >, in

Parameters

location A vector containing the Cartesian coordinates.

return type of : std:: array< double,2 >

Returns: The curvature values:; 0 The u parameter; 1 The v parameter

Public Member Functions

Detailed Description

Member Function Documentation

◆ area()

◆ closest_point_along_vector()

◆ closest_point_trimmed()

◆ color()

◆ dihedral_angle()

◆ get_param_range_U()

◆ get_param_range_V()

◆ is_cylindrical()

◆ is_planar()

◆ normal_at()

◆ ordered_loops()

◆ point_containment()

◆ position_from_u_v()

◆ principal_curvatures()

◆ set_color()

◆ u_v_from_position()