Stellarator-Tools
netcdf_inc::nf_get_var_real Interface Reference

Interface for reading real variables. Note double 2D array used by complex real array values. More...

Public Member Functions

integer function nf_get_var_cpx_real (ncid, varid, cvals)
 Read a 32bit complex value. More...
 
integer function nf_get_var_real (ncid, varid, rvals)
 Read a real value. More...
 
integer function nf_get_var_1d_real (ncid, varid, rvals)
 Read a real valued array. More...
 
integer function nf_get_var_1d_cpx_real (ncid, varid, cvals)
 Read a 32bit complex valued array. More...
 
integer function nf_get_var_2d_real (ncid, varid, rvals)
 Read a real valued 2D array. More...
 
integer function nf_get_var_2d_cpx_real (ncid, varid, cvals)
 Read a 32bit complex valued 2D array. More...
 
integer function nf_get_var_2d_double (ncid, varid, dvals)
 Read a double valued 2D array. More...
 
integer function nf_get_var_3d_real (ncid, varid, rvals)
 Read a real valued 3D array. More...
 
integer function nf_get_var_3d_cpx_real (ncid, varid, cvals)
 Read a 32bit complex valued 3D array. More...
 

Detailed Description

Interface for reading real variables. Note double 2D array used by complex real array values.

Constructor & Destructor Documentation

◆ nf_get_var_real()

integer function netcdf_inc::nf_get_var_real::nf_get_var_real ( integer, intent(in)  ncid,
integer, intent(in)  varid,
real (real32), intent(out)  rvals 
)

Read a real value.

Parameters
[in]ncidNetcdf file id.
[in]varidVariable id.
[out]rvalsReal to store the value.

Member Function/Subroutine Documentation

◆ nf_get_var_1d_cpx_real()

integer function netcdf_inc::nf_get_var_real::nf_get_var_1d_cpx_real ( integer, intent(in)  ncid,
integer, intent(in)  varid,
complex (real32), dimension(:), intent(out)  cvals 
)

Read a 32bit complex valued array.

Netcdf does not support complex types directly. Instead these values are interweaved into a real array.

Parameters
[in]ncidNetcdf file id.
[in]varidVariable id.
[out]cvalsComplex array to store the value.

◆ nf_get_var_1d_real()

integer function netcdf_inc::nf_get_var_real::nf_get_var_1d_real ( integer, intent(in)  ncid,
integer, intent(in)  varid,
real (real32), dimension(:), intent(out)  rvals 
)

Read a real valued array.

Parameters
[in]ncidNetcdf file id.
[in]varidVariable id.
[out]rvalsReal array to store the value.

◆ nf_get_var_2d_cpx_real()

integer function netcdf_inc::nf_get_var_real::nf_get_var_2d_cpx_real ( integer, intent(in)  ncid,
integer, intent(in)  varid,
complex (real32), dimension(:,:), intent(out)  cvals 
)

Read a 32bit complex valued 2D array.

Netcdf does not support complex types directly. Instead these values are interweaved into a real array.

Parameters
[in]ncidNetcdf file id.
[in]varidVariable id.
[out]cvalsComplex array to store the value.

◆ nf_get_var_2d_double()

integer function netcdf_inc::nf_get_var_real::nf_get_var_2d_double ( integer, intent(in)  ncid,
integer, intent(in)  varid,
real (real64), dimension(:,:), intent(out)  dvals 
)

Read a double valued 2D array.

Parameters
[in]ncidNetcdf file id.
[in]varidVariable id.
[out]dvalsDouble array to store the value.

◆ nf_get_var_2d_real()

integer function netcdf_inc::nf_get_var_real::nf_get_var_2d_real ( integer, intent(in)  ncid,
integer, intent(in)  varid,
real (real32), dimension(:,:), intent(out)  rvals 
)

Read a real valued 2D array.

Parameters
[in]ncidNetcdf file id.
[in]varidVariable id.
[out]rvalsReal 2D array to store the value.

◆ nf_get_var_3d_cpx_real()

integer function netcdf_inc::nf_get_var_real::nf_get_var_3d_cpx_real ( integer, intent(in)  ncid,
integer, intent(in)  varid,
complex (real32), dimension(:,:,:), intent(out)  cvals 
)

Read a 32bit complex valued 3D array.

Netcdf does not support complex types directly. Instead these values are interweaved into a real array.

Parameters
[in]ncidNetcdf file id.
[in]varidVariable id.
[out]cvalsComplex array to store the value.

◆ nf_get_var_3d_real()

integer function netcdf_inc::nf_get_var_real::nf_get_var_3d_real ( integer, intent(in)  ncid,
integer, intent(in)  varid,
real (real32), dimension(:,:,:), intent(out)  rvals 
)

Read a real valued 3D array.

Parameters
[in]ncidNetcdf file id.
[in]varidVariable id.
[out]rvalsReal 3D array to store the value.

◆ nf_get_var_cpx_real()

integer function netcdf_inc::nf_get_var_real::nf_get_var_cpx_real ( integer, intent(in)  ncid,
integer, intent(in)  varid,
complex (real32), intent(out)  cvals 
)

Read a 32bit complex value.

Netcdf does not support complex types directly. Instead these values are interweaved into a real array.

Parameters
[in]ncidNetcdf file id.
[in]varidVariable id.
[out]cvalsComplex to store the value.

The documentation for this interface was generated from the following file: