discretize.TreeMesh.get_tensor#

TreeMesh.get_tensor(key)[source]#

Return the base 1D arrays for a specified mesh tensor.

The cell-centers, nodes, x-faces, z-edges, etc… of a tensor mesh can be constructed by applying tensor products to the set of base 1D arrays; i.e. (vx, vy, vz). These 1D arrays define the gridded locations for the mesh tensor along each axis. For a given mesh tensor (i.e. cell centers, nodes, x/y/z faces or x/y/z edges), get_tensor returns a list containing the base 1D arrays.

Parameters:
keystr

Specifies the tensor being returned. Please choose from:

'CC', 'cell_centers' -> location of cell centers
'N', 'nodes'         -> location of nodes
'Fx', 'faces_x'      -> location of faces with an x normal
'Fy', 'faces_y'      -> location of faces with an y normal
'Fz', 'faces_z'      -> location of faces with an z normal
'Ex', 'edges_x'      -> location of edges with an x tangent
'Ey', 'edges_y'      -> location of edges with an y tangent
'Ez', 'edges_z'      -> location of edges with an z tangent
Returns:
(dim) list of 1D numpy.ndarray

list of base 1D arrays for the tensor.