pf_control Module Reference

module pf_control holds all the information to control the the main program More...

Collaboration diagram for pf_control:

Data Types
type	pf_control_type

Public Member Functions
subroutine	set_pf_controls
	subroutine to ensure pf_control data is ok More...
subroutine	parse_pf_parameters
	subroutine to read the namelist file and save it to pf datatype Here we read pf_parameters.dat or empire.nml More...
subroutine	deallocate_pf
	subroutine to deallocate space for the filtering code More...

Public Attributes
type(pf_control_type), save	pf
	the derived data type holding all controlling data More...

Detailed Description

module pf_control holds all the information to control the the main program

Definition at line 29 of file pf_control.f90.

Member Function/Subroutine Documentation

subroutine pf_control::deallocate_pf

(

)

subroutine to deallocate space for the filtering code

Definition at line 519 of file pf_control.f90.

Here is the caller graph for this function:

subroutine pf_control::parse_pf_parameters

(

)

subroutine to read the namelist file and save it to pf datatype Here we read pf_parameters.dat or empire.nml

pf_parameters.dat or empire.nml is a fortran namelist file. As such, within it there must be a line beginning

&pf_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 pf_parameters.dat (or empire.nml) file may contain the following things:

Integers:

• time_obs
• time_bwn_obs

Reals, double precision:

• nudgefac
• nfac
• ufac
• Qscale
• keep
• rho
• len

2 Characters:

• filter

1 Character:

• init

Logicals:

• gen_Q
• gen_data
• use_talagrand
• use_mean
• use_variance
• use_traj
• use_spatial_rmse
• output_forecast
• use_ens_rmse
• output_weights

250 Character string:

• rmse_filename
• forecast_path

Definition at line 216 of file pf_control.f90.

Here is the call graph for this function:

Here is the caller graph for this function:

subroutine pf_control::set_pf_controls

(

)

subroutine to ensure pf_control data is ok

Definition at line 146 of file pf_control.f90.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

type(pf_control_type), save pf_control::pf

the derived data type holding all controlling data

Definition at line 141 of file pf_control.f90.

---

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

• src/controllers/pf_control.f90