- class discretize.CurvilinearMesh(node_list, **kwargs)#
Curvilinear mesh class.
Curvilinear meshes are numerical grids whose cells are general quadrilaterals (2D) or cuboid (3D); unlike tensor meshes (see
TensorMesh) whose cells are rectangles or rectangular prisms. That being said, the combinatorial structure (i.e. connectivity of mesh cells) of curvilinear meshes is the same as tensor meshes.
example_curvilinear_grid()utility, we provide an example of a curvilinear mesh.
>>> from discretize import CurvilinearMesh >>> from discretize.utils import example_curvilinear_grid >>> import matplotlib.pyplot as plt
The example grid slightly rotates the nodes in the center of the mesh,
>>> x, y = example_curvilinear_grid([10, 10], "rotate") >>> x.shape (11, 11) >>> y.shape (11, 11) >>> curvilinear_mesh = CurvilinearMesh([x, y]) >>> curvilinear_mesh.shape_nodes (11, 11)
>>> fig = plt.figure(figsize=(5,5)) >>> ax = fig.add_subplot(111) >>> curvilinear_mesh.plot_grid(ax=ax) >>> plt.show()
area has been deprecated.
Averaging operator from x-edges to cell centers (scalar quantities).
Averaging operator from y-edges to cell centers (scalar quantities).
Averaging operator from z-edges to cell centers (scalar quantities).
Averaging operator from x-faces to cell centers (scalar quantities).
Averaging operator from y-faces to cell centers (scalar quantities).
Averaging operator from z-faces to cell centers (scalar quantities).
Deprecated since version 0.7.0.
Deprecated since version 0.7.0.
Deprecated since version 0.7.0.
Represents the operation of integrating a vector function on the boundary
Boundary edge locations
Outward normal vectors of boundary faces
Boundary face locations
Represents the operation of integrating a vector function dotted with the boundary normal
Boundary node locations
cellGrad has been deprecated.
cellGradBC has been deprecated.
cellGradx has been deprecated.
cellGrady has been deprecated.
cellGradz has been deprecated.
Return gridded cell center locations
Cell gradient operator (cell centers to faces)
Boundary conditions matrix for the cell gradient operator (Deprecated)
X-derivative operator (cell centers to x-faces)
Y-derivative operator (cell centers to y-faces)
Z-derivative operator (cell centers to z-faces)
Return cell volumes
The dimension of the mesh (1, 2, or 3).
edge has been deprecated.
edgeCurl has been deprecated.
Returns the lengths of all edges in the mesh
Unit tangent vectors for all mesh edges
Gridded edge locations
Gridded x-edge locations (staggered grid)
Gridded y-edge locations (staggered grid)
Gridded z-edge locations (staggered grid)
faceDiv has been deprecated.
faceDivx has been deprecated.
faceDivy has been deprecated.
faceDivz has been deprecated.
Returns the areas of all faces in the mesh
Unit normal vectors for all mesh faces
X-derivative operator (x-faces to cell-centres)
Y-derivative operator (y-faces to cell-centres)
Z-derivative operator (z-faces to cell-centres)
Gridded face locations
Gridded x-face locations (staggered grid)
Gridded y-face locations (staggered grid)
Gridded z-face locations (staggered grid)
Number of cells in the x direction
Number of cells in the y direction
Number of cells in the z direction
Number of nodes in the x-direction
Number of nodes in the y-direction
Number of nodes in the z-direction
Total number of cells in the mesh.
Total number of edges in the mesh
The number of edges in each direction
Number of x-edges in the mesh
Number of y-edges in the mesh
Number of z-edges in the mesh
Total number of faces in the mesh
The number of faces in each axis direction
Number of x-faces in the mesh
Number of y-faces in the mesh
Number of z-faces in the mesh
Total number of nodes in the mesh
nodalGrad has been deprecated.
nodalLaplacian has been deprecated.
Returns the gridded x, y (and z) node locations used to create the mesh.
Return gridded node locations
normals has been deprecated.
Rotation matrix defining mesh axes relative to Cartesian
Origin or 'anchor point' of the mesh
Indicates whether mesh uses standard coordinate axes
Coordinate reference system
The number of cells in each coordinate direction.
Number of x-edges along each axis direction
Number of y-edges along each axis direction
Number of z-edges along each axis direction
Number of x-faces along each axis direction
Number of y-faces along each axis direction
Number of z-faces along each axis direction
Returns the number of nodes along each axis direction
Differencing operator along x-direction (cell centers to x-faces)
Differencing operator along y-direction (cell centers to y-faces)
Differencing operator along z-direction (cell centers to z-faces)
tangents has been deprecated.
vol has been deprecated.
An alias for the
cell_gradient_weak_form_robin([alpha, beta, ...])
Robin conditions for weak form of the cell gradient operator (cell centers to faces)
closest_points_index(locations[, grid_loc, ...])
Find the indicies for the nearest grid location for a set of points.
Make a copy of the current mesh
Create this mesh from a dictionary of attributes
Robin conditions for weak form of the edge divergence operator (edges to nodes)
Compares current mesh with another mesh to determine if they are identical
Convert an OMF element to it's proper
getBCProjWF has been deprecated.
getBCProjWF_simple has been deprecated.
getEdgeInnerProduct has been deprecated.
getEdgeInnerProductDeriv has been deprecated.
getFaceInnerProduct has been deprecated.
getFaceInnerProductDeriv has been deprecated.
getInterpolationMat has been deprecated.
The weak form boundary condition projection matrices.
The weak form boundary condition projection matrices when mixed boundary condition is used
Construct linear interpolation matrix from mesh
plotGrid has been deprecated.
plotImage has been deprecated.
plotSlice has been deprecated.
plot_3d_slicer(v[, xslice, yslice, zslice, ...])
Plot slices of a 3D volume, interactively (scroll wheel).
plot_grid([ax, nodes, faces, centers, ...])
Plot the grid for nodal, cell-centered and staggered grids.
plot_image(v[, v_type, grid, view, ax, ...])
Plots quantities defined on a given mesh.
plot_slice(v[, v_type, normal, ind, ...])
Plots slice of fields on the given 3D mesh.
Finds cells that contain the given points.
projectEdgeVector has been deprecated.
projectFaceVector has been deprecated.
Project vectors to the edges of the mesh.
Project vectors onto the faces of the mesh.
r has been deprecated.
reshape(x[, x_type, out_type, format])
General reshape method for tensor quantities
Save the mesh to json
An alias for
setCellGradBC has been deprecated.
Set zero Dirichlet/Neumann boundary conditions for derivative operators acting on cell-centered quantities.
toVTK has been deprecated and replaced by to_vtk
Representation of the mesh's attributes as a dictionary
Convert this mesh object to it's proper
omfdata object with the given model dictionary as the cell data of that dataset.
Convert mesh (and models) to corresponding VTK or PyVista data object
Return the validation state of the mesh
writeVTK(file_name[, models, directory])
writeVTK has been deprecated and replaced by write_vtk
write_vtk(file_name[, models, directory])
Convert mesh (and models) to corresponding VTK or PyVista data object then writes to file