Ctrl+K

Class nBasisFunc

Class nBasisFunc#

Inheritance Relationships#

Base Type#

Derived Types#

Class Documentation#

tfc.utils.BF.BF_Py.nBasisFunc : public tfc.utils.BF.BF_Py.BasisFunc
Python implementation of the n-dimensional basis function classes.
See the Python implementation of `BasisFunc` for details.

Subclassed by tfc.utils.BF.BF_Py.nCP, tfc.utils.BF.BF_Py.nELM, tfc.utils.BF.BF_Py.nFS, tfc.utils.BF.BF_Py.nLeP

Public Functions

__init__(self, npt.NDArray x0, npt.NDArray xf, npt.NDArray nC, uint m, Number z0=0.0, Number zf=0.0)#
Initialize the basis class.

Parameters
----------
x0 : NDArray
    Start of the problem domain.
xf : NDArray
    End of the problem domain.
nC : NDArray
    Basis functions to be removed
m : uint
    Number of basis functions.
z0 : Number
    Start of the basis function domain.
zf : Number
    End of the basis function domain.
c(self)#
Return the constants that map the problem domain to the basis
function domain.

Returns
-------
npt.NDArray
    The constants that map the problem domain to the basis function
    domain.
numBasisFunc(self)#
Return the number of basis functions once user-specified
functions have been removed.

Returns
-------
float:
    The number of basis functions once the user-specified
    functions have been removed.
numBasisFuncFull(self)#
Return the number of basis functions before the user-specified
functions have been removed.

Returns
-------
float:
    The number of basis functions before the user-specified
    functions have been removed.
H(self, npt.NDArray x, npt.NDArray d, bool full=False)#
Returns the basis function matrix for the x with a derivative of order d.

Parameters
-----------
x : NDArray
    Input array. Values to calculate the basis function for.
    Should be size dim x N.
d : NDArray
    Order of the derivative
full: bool
    Whether to return the full basis function set, or remove
    the columns associated with self._nC.

Returns
-------
H : NDArray
    The basis function values.
Contents