NTPoly
Data Types | Functions/Subroutines
hermitesolversmodule Module Reference

A module for computing matrix functions based on Hermite polynomials. The Physicist variety. More...

Data Types

type  hermitepolynomial_t
 A datatype that represents a Hermite polynomial. More...
 

Functions/Subroutines

pure subroutine, public constructhermitepolynomial (this, degree)
 Construct a Hermite polynomial object. More...
 
pure subroutine, public destructhermitepolynomial (this)
 Destruct a Hermite polynomial object. More...
 
subroutine, public sethermitecoefficient (this, degree, coefficient)
 Set a coefficient of a Hermite polynomial. More...
 
subroutine, public hermitecompute (InputMat, OutputMat, poly, solver_parameters_in)
 Compute The Hermite Polynomial of the matrix. This method uses the standard Hermite Polynomial expansion. More...
 

Detailed Description

A module for computing matrix functions based on Hermite polynomials. The Physicist variety.

Function/Subroutine Documentation

◆ constructhermitepolynomial()

pure subroutine, public hermitesolversmodule::constructhermitepolynomial ( type(hermitepolynomial_t), intent(inout)  this,
integer, intent(in)  degree 
)

Construct a Hermite polynomial object.

Parameters
[in,out]thisthe polynomial to construct.
[in]degreeof the polynomial.

◆ destructhermitepolynomial()

pure subroutine, public hermitesolversmodule::destructhermitepolynomial ( type(hermitepolynomial_t), intent(inout)  this)

Destruct a Hermite polynomial object.

Parameters
[in,out]thisthe polynomial to destruct.

◆ hermitecompute()

subroutine, public hermitesolversmodule::hermitecompute ( type(distributedsparsematrix_t), intent(in)  InputMat,
type(distributedsparsematrix_t), intent(inout)  OutputMat,
type(hermitepolynomial_t), intent(in)  poly,
type(fixedsolverparameters_t), intent(in), optional  solver_parameters_in 
)

Compute The Hermite Polynomial of the matrix. This method uses the standard Hermite Polynomial expansion.

Parameters
[in]InputMatthe input matrix
[out]OutputMat= poly(InputMat)
[in]polypolynomial to compute.
[in]solver_parameters_inparameters for the solver (optional).

◆ sethermitecoefficient()

subroutine, public hermitesolversmodule::sethermitecoefficient ( type(hermitepolynomial_t), intent(inout)  this,
integer, intent(in)  degree,
real(ntreal), intent(in)  coefficient 
)

Set a coefficient of a Hermite polynomial.

Parameters
[in,out]thisthe polynomial to set.
[in]degreefor which to set the coefficient.
[in]coefficientvalue.