Geometry Factory#

Geometry factory module containing functions to create the different geometries.

ansys.dpf.core.geometry_factory.create_points(coordinates, server=None)#

Construct points given its coordinates.

Parameters:

coordinates (list, array, Field) – 3D coordinates of the points.
server (ansys.dpf.core.server, optional) – Server with the channel connected to the remote or local instance. The default is None, in which case an attempt is made to use the global server.

Examples

>>> from ansys.dpf.core.geometry_factory import create_points
>>> points = create_points([[1, 1, 1], [2, 1, 1], [0, 2, 0]])
>>> print(points)
DPF Points object:
Number of points: 3
Coordinates:
  [1. 1. 1.]
  [2. 1. 1.]
  [0. 2. 0.]
>>> points.plot()

ansys.dpf.core.geometry_factory.create_line_from_points(points, n_points=100, server=None)#

Construct line from two points.

Parameters:

points (list, array, Field, Points) – 3D coordinates of the points.
n_points (int) – Number of points in which the line will be discretized.
server (ansys.dpf.core.server, optional) – Server with the channel connected to the remote or local instance. The default is None, in which case an attempt is made to use the global server.

Examples

>>> from ansys.dpf.core.geometry_factory import create_line_from_points
>>> line = create_line_from_points([[0, 0, 0], [1, 1, 1]])
>>> print(line)
DPF Line object:
Starting point: [0. 0. 0.]
Ending point: [1. 1. 1.]
Line discretized with 100 points
>>> line.plot()

ansys.dpf.core.geometry_factory.create_line_from_vector(ini, end=None, n_points=100, server=None)#

Construct line from origin’s coordinates and a vector direction.

Parameters:

ini (list, array, Line) – List 3D coordinates of the initial and ending points of the line.
end (list, array, Line, optional) – 3D coordinates of the ending point of the line (if ini only contains the initial point).
n_points (int) – Number of points in which the line will be discretized.
server (ansys.dpf.core.server, optional) – Server with the channel connected to the remote or local instance. The default is None, in which case an attempt is made to use the global server.

Examples

>>> from ansys.dpf.core.geometry_factory import create_line_from_vector
>>> line = create_line_from_vector([0, 0, 0], [2, 2, 2])
>>> print(line)
DPF Line object:
Starting point: [0. 0. 0.]
Ending point: [2. 2. 2.]
Line discretized with 100 points
>>> line.plot()

ansys.dpf.core.geometry_factory.create_plane_from_center_and_normal(center, normal, width=1, height=1, n_cells_x=20, n_cells_y=20, server=None)#

Create plane from its center and normal direction.

Parameters:

center (list, array, Points) – 3D coordinates of the center point of the plane.
normal (list, array, Line) – Normal direction to the plane.
width (int, float) – Width of the discretized plane (default = 1).
height (int, float) – Height of the discretized plane (default = 1).
n_cells_x (int) – Number of cells in the x direction of the plane (default = 20).
n_cells_y (int) – Number of cells in the y direction of the plane (default = 20).
server (ansys.dpf.core.server, optional) – Server with the channel connected to the remote or local instance. The default is None, in which case an attempt is made to use the global server.

Examples

>>> from ansys.dpf.core.geometry_factory import create_plane_from_center_and_normal
>>> plane = create_plane_from_center_and_normal([1, 1, 1], [0, 0, 1])
>>> print(plane)
DPF Plane object:
Center point: [1, 1, 1]
Normal direction: [0. 0. 1.]
Plane discretizaton using:
  Width (x-dir): 1
  Height (y-dir): 1
  Num cells x-dir: 20
  Num cells y-dir: 20
>>> plane.plot()

ansys.dpf.core.geometry_factory.create_plane_from_points(points, n_cells_x=20, n_cells_y=20, server=None)#

Create plane from three points.

Note that when creating a plane using three points, the plane’s width and height will be computed such that the three points are the corner points of the plane.

Parameters:

points (list, array, Points) – 3D coordinates of the three points defining the plane.
n_cells_x (int) – Number of cells in the x direction of the plane (default = 20).
n_cells_y (int) – Number of cells in the y direction of the plane (default = 20).
server (ansys.dpf.core.server, optional) – Server with the channel connected to the remote or local instance. The default is None, in which case an attempt is made to use the global server.

Examples

>>> from ansys.dpf.core.geometry_factory import create_plane_from_points
>>> plane = create_plane_from_points([[0, 0, 0], [0, 0, 4], [0, 4, 0]])
>>> print(plane)
DPF Plane object:
Center point: [0.0, 1.3333333333333333, 1.3333333333333333]
Normal direction: [-1.  0.  0.]
Plane discretizaton using:
  Width (x-dir): 4.0
  Height (y-dir): 4.0
  Num cells x-dir: 20
  Num cells y-dir: 20
>>> plane.plot()

ansys.dpf.core.geometry_factory.create_plane_from_lines(line1, line2, width=1, height=1, n_cells_x=20, n_cells_y=20, server=None)#

Create plane from two lines.

Parameters:

line1 (list, array, Line) – 3D coordinates of the two points defining a line.
line2 (list, array, Line) – 3D coordinates of the two points defining a line.
width (int, float) – Width of the discretized plane (default = 1).
height (int, float) – Height of the discretized plane (default = 1).
n_cells_x (int) – Number of cells in the x direction of the plane (default = 20).
n_cells_y (int) – Number of cells in the y direction of the plane (default = 20).
server (ansys.dpf.core.server, optional) – Server with the channel connected to the remote or local instance. The default is None, in which case an attempt is made to use the global server.

Examples

>>> from ansys.dpf.core.geometry_factory import create_plane_from_lines
>>> plane = create_plane_from_lines([[0, 0, 0], [1, 1, 1]], [[0, 1, 0], [2, 1, 0]])
>>> print(plane)
DPF Plane object:
Center point: [-1.5, -0.5, -0.5]
Normal direction: [ 0.          0.70710678 -0.70710678]
Plane discretizaton using:
  Width (x-dir): 1
  Height (y-dir): 1
  Num cells x-dir: 20
  Num cells y-dir: 20
>>> plane.plot()

ansys.dpf.core.geometry_factory.create_plane_from_point_and_line(point, line, width=1, height=1, n_cells_x=20, n_cells_y=20, server=None)#

Create plane from point and line.

Parameters:

point (list, array, Points) – 3D coordinates of the point.
line (list, array, Line) – 3D coordinates of the two points defining a line.
width (int, float) – Width of the discretized plane (default = 1).
height (int, float) – Height of the discretized plane (default = 1).
n_cells_x (int) – Number of cells in the x direction of the plane (default = 20).
n_cells_y (int) – Number of cells in the y direction of the plane (default = 20).
server (ansys.dpf.core.server, optional) – Server with the channel connected to the remote or local instance. The default is None, in which case an attempt is made to use the global server.

Examples

>>> from ansys.dpf.core.geometry_factory import create_plane_from_point_and_line
>>> plane = create_plane_from_point_and_line([1, 2, 1], [[0, 0, 0], [1, 1, 1]])
>>> print(plane)
DPF Plane object:
Center point: [0.6666666666666666, 1.0, 0.6666666666666666]
Normal direction: [-0.70710678  0.          0.70710678]
Plane discretizaton using:
  Width (x-dir): 1
  Height (y-dir): 1
  Num cells x-dir: 20
  Num cells y-dir: 20
>>> plane.plot()

ansys.dpf.core.geometry_factory.get_center_from_coords(coords)#: Get average coordinates from several points.

ansys.dpf.core.geometry_factory.get_normal_direction_from_coords(points)#: Get normal direction between three points.

ansys.dpf.core.geometry_factory.get_cross_product(vects)#: Compute cross product between two vectors.