Fortran interface to ObsSpace. More...

Data Types
interface	obsspace_get_db

interface	obsspace_put_db

Functions/Subroutines
type(c_ptr) function, public	obsspace_construct (c_conf, tbegin, tend)

subroutine, public	obsspace_destruct (c_obss)

subroutine, public	obsspace_obsname (obss, obsname)
	Get obsname from ObsSpace. More...

type(oops_variables) function, public	obsspace_obsvariables (obss)
	Get obsvariables from ObsSpace. More...

integer function, public	obsspace_get_gnlocs (c_obss)
	Return the number of observational locations in the input obs file. More...

integer function, public	obsspace_get_nlocs (c_obss)
	Return the number of observational locations in the obs space. More...

integer function, public	obsspace_get_nchans (c_obss)
	Return the number of channels in obs space (zero if conventional obs type) More...

integer function, public	obsspace_get_nrecs (c_obss)
	Return the number of observational records (profiles) More...

integer function, public	obsspace_get_nvars (c_obss)
	Return the number of observational variables. More...

subroutine, public	obsspace_get_dim_name (obss, dim_id, dim_name)
	Return the ObsSpace dimension name given the dimension id. More...

integer function, public	obsspace_get_dim_size (obss, dim_id)
	Return the size of the ObsSpace dimension given the dimension id. More...

integer function, public	obsspace_get_dim_id (obss, dim_name)
	Return the ObsSpace dimension id given the dimension name. More...

subroutine, public	obsspace_get_comm (obss, f_comm)
	Return the name and name length of obsspace communicator. More...

subroutine, public	obsspace_get_recnum (obss, recnum)
	Get the record number vector. More...

subroutine, public	obsspace_get_index (obss, indx)
	Get the index vector. More...

logical function, public	obsspace_has (c_obss, group, vname)
	Return true if variable exists in database. More...

subroutine	obsspace_get_db_int32 (obss, group, vname, vect, chan_select)
	Get a variable from the ObsSapce database. More...

subroutine	obsspace_get_db_int64 (obss, group, vname, vect, chan_select)
	Get a variable from the ObsSapce database. More...

subroutine	obsspace_get_db_real32 (obss, group, vname, vect, chan_select)
	Get a variable from the ObsSapce database. More...

subroutine	obsspace_get_db_real64 (obss, group, vname, vect, chan_select)
	Get a variable from the ObsSapce database. More...

subroutine	obsspace_get_db_datetime (obss, group, vname, vect, chan_select)
	Get datetime from the ObsSapce database. More...

subroutine	obsspace_put_db_int32 (obss, group, vname, vect, dim_ids)
	Store a vector in ObsSpace database. More...

subroutine	obsspace_put_db_int64 (obss, group, vname, vect, dim_ids)
	Store a vector in ObsSpace database. More...

subroutine	obsspace_put_db_real32 (obss, group, vname, vect, dim_ids)
	Store a vector in ObsSpace database. More...

subroutine	obsspace_put_db_real64 (obss, group, vname, vect, dim_ids)
	Store a vector in ObsSpace database. More...

integer(c_int) function, public	obsspace_get_nlocs_dim_id ()
	Return the identifier of the nlocs dimension. More...

integer(c_int) function, public	obsspace_get_nchans_dim_id ()
	Return the identifier of the nchans dimension. More...

Detailed Description

Fortran interface to ObsSpace.

Function/Subroutine Documentation

◆ obsspace_construct()

type(c_ptr) function, public obsspace_mod::obsspace_construct	(	type(fckit_configuration), intent(in)	c_conf,
		type(datetime), intent(in)	tbegin,
		type(datetime), intent(in)	tend
	)

Definition at line 63 of file obsspace_mod.F90.

◆ obsspace_destruct()

subroutine, public obsspace_mod::obsspace_destruct ( type(c_ptr), intent(inout) c_obss )

Definition at line 78 of file obsspace_mod.F90.

◆ obsspace_get_comm()

subroutine, public obsspace_mod::obsspace_get_comm	(	type(c_ptr), intent(in)	obss,
		type(fckit_mpi_comm), intent(out)	f_comm
	)

Return the name and name length of obsspace communicator.

Definition at line 229 of file obsspace_mod.F90.

◆ obsspace_get_db_datetime()

subroutine obsspace_mod::obsspace_get_db_datetime	(	type(c_ptr), intent(in), value	obss,
		character(len=*), intent(in)	group,
		character(len=*), intent(in)	vname,
		type(datetime), dimension(:), intent(inout)	vect,
		integer(c_int), dimension(:), intent(in), optional	chan_select
	)

private

Get datetime from the ObsSapce database.

Definition at line 432 of file obsspace_mod.F90.

◆ obsspace_get_db_int32()

subroutine obsspace_mod::obsspace_get_db_int32	(	type(c_ptr), intent(in), value	obss,
		character(len=*), intent(in)	group,
		character(len=*), intent(in)	vname,
		integer(c_int32_t), dimension(:), intent(inout)	vect,
		integer(c_int), dimension(:), intent(in), optional	chan_select
	)

private

Get a variable from the ObsSapce database.

Definition at line 297 of file obsspace_mod.F90.

◆ obsspace_get_db_int64()

subroutine obsspace_mod::obsspace_get_db_int64	(	type(c_ptr), intent(in), value	obss,
		character(len=*), intent(in)	group,
		character(len=*), intent(in)	vname,
		integer(c_int64_t), dimension(:), intent(inout)	vect,
		integer(c_int), dimension(:), intent(in), optional	chan_select
	)

private

Get a variable from the ObsSapce database.

Definition at line 331 of file obsspace_mod.F90.

◆ obsspace_get_db_real32()

subroutine obsspace_mod::obsspace_get_db_real32	(	type(c_ptr), intent(in), value	obss,
		character(len=*), intent(in)	group,
		character(len=*), intent(in)	vname,
		real(c_float), dimension(:), intent(inout)	vect,
		integer(c_int), dimension(:), intent(in), optional	chan_select
	)

private

Get a variable from the ObsSapce database.

Definition at line 364 of file obsspace_mod.F90.

◆ obsspace_get_db_real64()

subroutine obsspace_mod::obsspace_get_db_real64	(	type(c_ptr), intent(in), value	obss,
		character(len=*), intent(in)	group,
		character(len=*), intent(in)	vname,
		real(c_double), dimension(:), intent(inout)	vect,
		integer(c_int), dimension(:), intent(in), optional	chan_select
	)

private

Get a variable from the ObsSapce database.

Definition at line 397 of file obsspace_mod.F90.

◆ obsspace_get_dim_id()

integer function, public obsspace_mod::obsspace_get_dim_id	(	type(c_ptr), intent(in)	obss,
		character(len=*), intent(in)	dim_name
	)

Return the ObsSpace dimension id given the dimension name.

Definition at line 214 of file obsspace_mod.F90.

◆ obsspace_get_dim_name()

subroutine, public obsspace_mod::obsspace_get_dim_name	(	type(c_ptr), intent(in), value	obss,
		integer, intent(in)	dim_id,
		character(*), intent(inout)	dim_name
	)

Return the ObsSpace dimension name given the dimension id.

Definition at line 179 of file obsspace_mod.F90.

◆ obsspace_get_dim_size()

integer function, public obsspace_mod::obsspace_get_dim_size	(	type(c_ptr), intent(in)	obss,
		integer, intent(in)	dim_id
	)

Return the size of the ObsSpace dimension given the dimension id.

Definition at line 202 of file obsspace_mod.F90.

◆ obsspace_get_gnlocs()

integer function, public obsspace_mod::obsspace_get_gnlocs ( type(c_ptr), intent(in) c_obss )

Return the number of observational locations in the input obs file.

Definition at line 124 of file obsspace_mod.F90.

◆ obsspace_get_index()

subroutine, public obsspace_mod::obsspace_get_index	(	type(c_ptr), intent(in)	obss,
		integer(c_size_t), dimension(:), intent(inout)	indx
	)

Get the index vector.

Definition at line 265 of file obsspace_mod.F90.

◆ obsspace_get_nchans()

integer function, public obsspace_mod::obsspace_get_nchans ( type(c_ptr), intent(in) c_obss )

Return the number of channels in obs space (zero if conventional obs type)

Definition at line 146 of file obsspace_mod.F90.

◆ obsspace_get_nchans_dim_id()

integer(c_int) function, public obsspace_mod::obsspace_get_nchans_dim_id

Return the identifier of the nchans dimension.

Definition at line 623 of file obsspace_mod.F90.

◆ obsspace_get_nlocs()

integer function, public obsspace_mod::obsspace_get_nlocs ( type(c_ptr), intent(in) c_obss )

Return the number of observational locations in the obs space.

Definition at line 135 of file obsspace_mod.F90.

◆ obsspace_get_nlocs_dim_id()

integer(c_int) function, public obsspace_mod::obsspace_get_nlocs_dim_id

Return the identifier of the nlocs dimension.

Definition at line 615 of file obsspace_mod.F90.

Here is the caller graph for this function:

◆ obsspace_get_nrecs()

integer function, public obsspace_mod::obsspace_get_nrecs ( type(c_ptr), intent(in) c_obss )

Return the number of observational records (profiles)

Definition at line 157 of file obsspace_mod.F90.

◆ obsspace_get_nvars()

integer function, public obsspace_mod::obsspace_get_nvars ( type(c_ptr), intent(in) c_obss )

Return the number of observational variables.

Definition at line 168 of file obsspace_mod.F90.

◆ obsspace_get_recnum()

subroutine, public obsspace_mod::obsspace_get_recnum	(	type(c_ptr), intent(in)	obss,
		integer(c_size_t), dimension(:), intent(inout)	recnum
	)

Get the record number vector.

Definition at line 252 of file obsspace_mod.F90.

◆ obsspace_has()

logical function, public obsspace_mod::obsspace_has	(	type(c_ptr), intent(in)	c_obss,
		character(len=*), intent(in)	group,
		character(len=*), intent(in)	vname
	)

Return true if variable exists in database.

Definition at line 280 of file obsspace_mod.F90.

◆ obsspace_obsname()

subroutine, public obsspace_mod::obsspace_obsname	(	type(c_ptr), intent(in), value	obss,
		character(*), intent(inout)	obsname
	)

Get obsname from ObsSpace.

Definition at line 90 of file obsspace_mod.F90.

◆ obsspace_obsvariables()

type(oops_variables) function, public obsspace_mod::obsspace_obsvariables ( type(c_ptr), intent(in), value obss )

Get obsvariables from ObsSpace.

Definition at line 113 of file obsspace_mod.F90.

◆ obsspace_put_db_int32()

subroutine obsspace_mod::obsspace_put_db_int32	(	type(c_ptr), intent(in), value	obss,
		character(len=*), intent(in)	group,
		character(len=*), intent(in)	vname,
		integer(c_int32_t), dimension(:), intent(in)	vect,
		integer(c_int), dimension(:), intent(in), optional	dim_ids
	)

private

Store a vector in ObsSpace database.

Definition at line 480 of file obsspace_mod.F90.

◆ obsspace_put_db_int64()

subroutine obsspace_mod::obsspace_put_db_int64	(	type(c_ptr), intent(in), value	obss,
		character(len=*), intent(in)	group,
		character(len=*), intent(in)	vname,
		integer(c_int64_t), dimension(:), intent(in)	vect,
		integer(c_int), dimension(:), intent(in), optional	dim_ids
	)

private

Store a vector in ObsSpace database.

Definition at line 513 of file obsspace_mod.F90.

◆ obsspace_put_db_real32()

subroutine obsspace_mod::obsspace_put_db_real32	(	type(c_ptr), intent(in), value	obss,
		character(len=*), intent(in)	group,
		character(len=*), intent(in)	vname,
		real(c_float), dimension(:), intent(in)	vect,
		integer(c_int), dimension(:), intent(in), optional	dim_ids
	)

private

Store a vector in ObsSpace database.

Definition at line 547 of file obsspace_mod.F90.

◆ obsspace_put_db_real64()

subroutine obsspace_mod::obsspace_put_db_real64	(	type(c_ptr), intent(in), value	obss,
		character(len=*), intent(in)	group,
		character(len=*), intent(in)	vname,
		real(c_double), dimension(:), intent(in)	vect,
		integer(c_int), dimension(:), intent(in), optional	dim_ids
	)

private

Store a vector in ObsSpace database.

Definition at line 582 of file obsspace_mod.F90.

Data Types

Functions/Subroutines

Detailed Description

Function/Subroutine Documentation

◆ obsspace_construct()

◆ obsspace_destruct()

◆ obsspace_get_comm()

◆ obsspace_get_db_datetime()

◆ obsspace_get_db_int32()

◆ obsspace_get_db_int64()

◆ obsspace_get_db_real32()

◆ obsspace_get_db_real64()

◆ obsspace_get_dim_id()

◆ obsspace_get_dim_name()

◆ obsspace_get_dim_size()

◆ obsspace_get_gnlocs()

◆ obsspace_get_index()

◆ obsspace_get_nchans()

◆ obsspace_get_nchans_dim_id()

◆ obsspace_get_nlocs()

◆ obsspace_get_nlocs_dim_id()

◆ obsspace_get_nrecs()

◆ obsspace_get_nvars()

◆ obsspace_get_recnum()

◆ obsspace_has()

◆ obsspace_obsname()

◆ obsspace_obsvariables()

◆ obsspace_put_db_int32()

◆ obsspace_put_db_int64()

◆ obsspace_put_db_real32()

◆ obsspace_put_db_real64()