discretize.base.BaseRectangularMesh

Inheritance diagram of BaseRectangularMesh
class discretize.base.BaseRectangularMesh(shape_cells, origin=None, orientation=None, reference_system=None, **kwargs)[source]

Base rectangular mesh class for the discretize package.

The BaseRectangularMesh class acts as an extension of the BaseMesh classes with a regular structure.

Attributes

axis_u

Deprecated since version 0.7.0.

axis_v

Deprecated since version 0.7.0.

axis_w

Deprecated since version 0.7.0.

dim

The dimension of the mesh (1, 2, or 3).

edge_tangents

Unit tangent vectors for all mesh edges

face_normals

Unit normal vectors for all mesh faces

nCx

Number of cells in the x direction

nCy

Number of cells in the y direction

nCz

Number of cells in the z direction

nNx

Number of nodes in the x-direction

nNy

Number of nodes in the y-direction

nNz

Number of nodes in the z-direction

n_cells

Total number of cells in the mesh.

n_edges

Total number of edges in the mesh

n_edges_per_direction

The number of edges in each direction

n_edges_x

Number of x-edges in the mesh

n_edges_y

Number of y-edges in the mesh

n_edges_z

Number of z-edges in the mesh

n_faces

Total number of faces in the mesh

n_faces_per_direction

The number of faces in each axis direction

n_faces_x

Number of x-faces in the mesh

n_faces_y

Number of y-faces in the mesh

n_faces_z

Number of z-faces in the mesh

n_nodes

Total number of nodes in the mesh

normals

normals has been deprecated.

orientation

Rotation matrix defining mesh axes relative to Cartesian

origin

Origin or 'anchor point' of the mesh

reference_is_rotated

Indicates whether mesh uses standard coordinate axes

reference_system

Coordinate reference system

rotation_matrix

Alias for orientation

shape_cells

The number of cells in each coordinate direction.

shape_edges_x

Number of x-edges along each axis direction

shape_edges_y

Number of y-edges along each axis direction

shape_edges_z

Number of z-edges along each axis direction

shape_faces_x

Number of x-faces along each axis direction

shape_faces_y

Number of y-faces along each axis direction

shape_faces_z

Number of z-faces along each axis direction

shape_nodes

Returns the number of nodes along each axis direction

tangents

tangents has been deprecated.

x0

An alias for the origin

Methods

copy()

Make a copy of the current mesh

deserialize(items, **kwargs)

Create this mesh from a dictionary of attributes

equals(other_mesh)

Compares current mesh with another mesh to determine if they are identical

projectEdgeVector(*args, **kwargs)

projectEdgeVector has been deprecated.

projectFaceVector(*args, **kwargs)

projectFaceVector has been deprecated.

project_edge_vector(edge_vectors)

Project vectors to the edges of the mesh.

project_face_vector(face_vectors)

Project vectors onto the faces of the mesh.

r(*args, **kwargs)

r has been deprecated.

reshape(x[, x_type, out_type, format])

General reshape method for tensor quantities

save([file_name, verbose])

Save the mesh to json

serialize()

An alias for to_dict()

to_dict()

Representation of the mesh's attributes as a dictionary

validate()

Return the validation state of the mesh