Module that stores the information about the timestepping process. More...

Collaboration diagram for timestep_data:

Data Types
type	timestep_data_type

Public Member Functions
subroutine	timestep_data_allocate_obs_times (n)
	subroutine to allocate space for obs_times array More...

subroutine	timestep_data_deallocate_obs_times
	subroutine to deallocate obs_times array More...

subroutine	timestep_data_set_obs_times (obs_num_in_time, timestep)
	subroutine to set the timestep corresponding to the observation number in time More...

subroutine	timestep_data_set_next_ob_time (ob_time)
	subroutine to set the next observation timestep More...

subroutine	timestep_data_get_obs_times (obs_num_in_time, timestep)
	subroutine to extract the timestep corresponding to the observation number in time More...

subroutine	timestep_data_set_do_analysis
	subroutine to define if the current timestep should perform an analysis More...

subroutine	timestep_data_set_do_no_analysis
	subroutine to define if the current timestep should not perform an analysis More...

subroutine	timestep_data_set_is_analysis
	subroutine to define if the current ensemble is an analysis More...

subroutine	timestep_data_set_no_analysis
	subroutine to define if the current ensemble is not an analysis More...

subroutine	timestep_data_set_completed (t)
	subroutine to define the number of completed timesteps More...

subroutine	timestep_data_set_current (t)
	subroutine to define the current timestep More...

subroutine	timestep_data_set_total (t)
	subroutine to define the total number of timesteps that the model will run for More...

subroutine	timestep_data_set_tau (pseudotimestep)
	subroutine to define the current number of timesteps between observations More...

Public Attributes
type(timestep_data_type), save	tsdata
	the derived data type holding all timestep data More...

Detailed Description

Module that stores the information about the timestepping process.

Definition at line 30 of file timestep_data.f90.

Member Function/Subroutine Documentation

subroutine timestep_data::timestep_data_allocate_obs_times ( integer, intent(in) n )

subroutine to allocate space for obs_times array

Definition at line 60 of file timestep_data.f90.

Here is the caller graph for this function:

subroutine timestep_data::timestep_data_deallocate_obs_times ( )

subroutine to deallocate obs_times array

Definition at line 75 of file timestep_data.f90.

subroutine timestep_data::timestep_data_get_obs_times	(	integer, intent(in)	obs_num_in_time,
		integer, intent(out)	timestep
	)

subroutine to extract the timestep corresponding to the observation number in time

Definition at line 99 of file timestep_data.f90.

subroutine timestep_data::timestep_data_set_completed ( integer, intent(in) t )

subroutine to define the number of completed timesteps

Definition at line 132 of file timestep_data.f90.

Here is the caller graph for this function:

subroutine timestep_data::timestep_data_set_current ( integer, intent(in) t )

subroutine to define the current timestep

Definition at line 139 of file timestep_data.f90.

Here is the caller graph for this function:

subroutine timestep_data::timestep_data_set_do_analysis ( )

subroutine to define if the current timestep should perform an analysis

Definition at line 107 of file timestep_data.f90.

Here is the caller graph for this function:

subroutine timestep_data::timestep_data_set_do_no_analysis ( )

subroutine to define if the current timestep should not perform an analysis

Definition at line 114 of file timestep_data.f90.

Here is the caller graph for this function:

subroutine timestep_data::timestep_data_set_is_analysis ( )

subroutine to define if the current ensemble is an analysis

Definition at line 120 of file timestep_data.f90.

Here is the caller graph for this function:

subroutine timestep_data::timestep_data_set_next_ob_time ( integer, intent(in) ob_time )

subroutine to set the next observation timestep

Definition at line 90 of file timestep_data.f90.

Here is the caller graph for this function:

subroutine timestep_data::timestep_data_set_no_analysis ( )

subroutine to define if the current ensemble is not an analysis

Definition at line 126 of file timestep_data.f90.

Here is the caller graph for this function:

subroutine timestep_data::timestep_data_set_obs_times	(	integer, intent(in)	obs_num_in_time,
		integer, intent(in)	timestep
	)

subroutine to set the timestep corresponding to the observation number in time

Definition at line 81 of file timestep_data.f90.

Here is the caller graph for this function:

subroutine timestep_data::timestep_data_set_tau ( integer, intent(in) pseudotimestep )

subroutine to define the current number of timesteps between observations

Definition at line 154 of file timestep_data.f90.

Here is the caller graph for this function:

subroutine timestep_data::timestep_data_set_total ( integer, intent(in) t )

subroutine to define the total number of timesteps that the model will run for

Definition at line 147 of file timestep_data.f90.

Here is the caller graph for this function:

Member Data Documentation

type(timestep_data_type), save timestep_data::tsdata

the derived data type holding all timestep data

Definition at line 55 of file timestep_data.f90.

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

src/controllers/timestep_data.f90

Data Types

Public Member Functions

Public Attributes

Detailed Description

Member Function/Subroutine Documentation

Member Data Documentation