QPMS
/
qpms
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

BaseSpec constructor docs

This commit is contained in:
Marek Nečada 2022-05-25 06:09:31 +03:00
parent cf4b9cb52b
commit 6ddcc4cfcf
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
qpms/cybspec.pyx
View File

@ -35,6 +35,13 @@ cdef class BaseSpec:
whenever used in other wrapper classes that need the pointer whenever used in other wrapper classes that need the pointer
to qpms_vswf_set_spec_t, remember to set a (private, probably immutable) reference to qpms.basespec to ensure to qpms_vswf_set_spec_t, remember to set a (private, probably immutable) reference to qpms.basespec to ensure
correct reference counting and garbage collection. correct reference counting and garbage collection.
BaseSpec can be constructed either using a single keyword argument `lMax` to include
all the transversal vector spherical wavefunction to a specific degree, or
using an explicit list of integer basis VSWF codes, \see qpms_uvswfi_t
BaseSpec(lMax = <positive_integer>)
or
BaseSpec([ uvswfi0, ... ])
''' '''
#cdef qpms_vswf_set_spec_t s # in pxd #cdef qpms_vswf_set_spec_t s # in pxd
#cdef np.ndarray __ilist # in pxd #cdef np.ndarray __ilist # in pxd