var_data Module Reference

module holding data for variational problems More...

Collaboration diagram for var_data:

Data Types
type	var_control_type

Public Member Functions
subroutine	set_var_controls
	subroutine to ensure vardata is ok More...
subroutine	parse_vardata
	subroutine to read the namelist file and save it to vardata datatype Here we read vardata.nml More...
subroutine	allocate_vardata
	subroutine to allocate space for 4denvar More...
subroutine	deallocate_vardata
	subroutine to deallocate space for 4denvar More...
subroutine	read_lbfgsb_bounds
	subroutine to somehow read in bounds data More...
subroutine	read_observation_numbers
	subroutine to somehow read in observation numbers More...

Public Attributes
type(var_control_type), save	vardata
	the derived data type holding all controlling data More...

Detailed Description

module holding data for variational problems

Definition at line 29 of file var_data.f90.

Member Function/Subroutine Documentation

subroutine var_data::allocate_vardata

(

)

subroutine to allocate space for 4denvar

Definition at line 328 of file var_data.f90.

Here is the caller graph for this function:

subroutine var_data::deallocate_vardata

(

)

subroutine to deallocate space for 4denvar

Definition at line 343 of file var_data.f90.

Here is the caller graph for this function:

subroutine var_data::parse_vardata

(

)

subroutine to read the namelist file and save it to vardata datatype Here we read vardata.nml

vardata.nml is a fortran namelist file. As such, within it there must be a line beginning

&var_params

To make it (probably) work, ensure there is a forward slash on the penultimate line and a blank line to end the file

This is just the fortran standard for namelists though.

On to the content...in any order, the vardata.nml may contain the following things:

Integers:

• cg_method

Reals, double precision:

• lbfgs_factr
• lbfgs_pgtol

6 Characters:

• opt_method

Definition at line 139 of file var_data.f90.

Here is the caller graph for this function:

subroutine var_data::read_lbfgsb_bounds

(

)

subroutine to somehow read in bounds data

Definition at line 353 of file var_data.f90.

Here is the caller graph for this function:

subroutine var_data::read_observation_numbers

(

)

subroutine to somehow read in observation numbers

Definition at line 357 of file var_data.f90.

Here is the caller graph for this function:

subroutine var_data::set_var_controls

(

)

subroutine to ensure vardata is ok

Definition at line 98 of file var_data.f90.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

type(var_control_type), save var_data::vardata

the derived data type holding all controlling data

Definition at line 93 of file var_data.f90.

---

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

• src/4dEnVar/var_data.f90