Skip to content
Snippets Groups Projects
Commit 5f1e8f71 authored by Koerber, Lukas (FWIN-C) - 108045's avatar Koerber, Lukas (FWIN-C) - 108045
Browse files

Documentation

parent 491a397a
No related branches found
No related tags found
No related merge requests found
"""
This submodule contains a number of mathematical functions.
This submodule contains a number of mathematical functions. The import convention
>>> import numpy as np
is used.
"""
import numpy as np
from scipy.sparse import dia_matrix, bmat
......@@ -29,7 +33,7 @@ def flattened_mesh_vec_abs(vec):
Returns
-------
numpy.array
np.array
Flattened mesh scalar of shape `(N,)`.
"""
nx = vec.shape[0] // 3
......@@ -193,16 +197,16 @@ def spherical_angles_to_mesh_vector(theta, phi, as_flattened=False):
Parameters
----------
theta : numpy.array
theta : np.array
Polar angle at each node point.
phi : numpy.array
phi : np.array
Azimuthal angle at each node point.
as_flattened : bool, optional
Return resulting unit vector as flattened mesh vector (default is `False`).
Returns
-------
numpy.array
np.array
Unit mesh vector of shape `(N, 3)` if `as_flattened=False` or as flattened mesh vector of shape `(3*N,)` if `as_flattened=True`.
"""
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment