Class nBasisFunc#

Inheritance Relationships#

Base Type#

Derived Types#

Class Documentation#

tfc.utils.BF_Py.nBasisFunc : public tfc.utils.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_Py.nCP, tfc.utils.BF_Py.nELM, tfc.utils.BF_Py.nFS, tfc.utils.BF_Py.nLeP

Public Functions

__init__(self, JaxOrNumpyArray x0, JaxOrNumpyArray xf, JaxOrNumpyArray 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
-------
JaxOrNumpyArray
    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, JaxOrNumpyArray x, JaxOrNumpyArray 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.

Protected Functions

_NumBasisFunc(self, int dim, JaxOrNumpyArray vec, int n=0, bool full=False)#
Calculate the number of basis functions.

Parameters
----------
dim : int
    Number of dimensions.
vec : NDArray
    Vector used to keep track of the order of the basis function.
n : int, optional
    Count of the number of basis functions so far. (Default value = 0)
full : bool, optional
    If true, then does not remove basis functions based on self._nC. (Default value = False)

Returns
-------
int
    Number of basis functions.

Protected Attributes

_m#
_nC#
_dim#
_numC#
_z0#
_zf#
_x0#
_c#
_numBasisFunc#
_numBasisFuncFull#