Derived type to manage variables with ocean component. More...

Public Member Functions
procedure	init (this, ocean_mesh)
	Setup an object to manage variables with ocean component.
procedure	final (this)
	Finalize an object to manage variables with ocean component.
procedure	history (this)
	Put data with oceanic variables to history file.
procedure	read_restart_file (this, ocean_mesh)
	Read data with oceanic variables from restart file.
procedure	write_restart_file_prep (this)
	Write data with oceanic variables to restart file.
procedure	write_restart_file (this)
	Write data with oceanic variables to restart file.
procedure	write_restart_file_post (this)
	Close restart file for oceanic variables.

Public Attributes
class(oceanmesh), pointer	mesh
	Pointer to an object to manage a primary mesh for ocean component.
type(meshfield3d), dimension(:), allocatable	prog_vars
	Array of 3D prognostic variables.
type(modelvarmanager)	progvars_manager
	An object to manage prognostic variables.
type(meshfield3d), dimension(:), allocatable	qtrc_vars
	Array of 3D tracer variables.
type(modelvarmanager)	qtrcvars_manager
	An object to manage tracer variables.
type(meshfield3d), dimension(:), allocatable	aux_vars
	Array of 3D auxiliary variables.
type(modelvarmanager)	auxvars_manager
	Object to manage 3D auxiliary variables.
type(meshfield2d), dimension(:), allocatable	aux_vars2d
	Array of 2D auxiliary variables.
type(modelvarmanager)	auxvars2d_manager
	An object to manage 2D auxiliary variables.
type(meshfield2d), dimension(:), allocatable	atm_vars2d
	Array of 2D atmospheric variables.
type(meshfield2d), dimension(:), allocatable	ocn_sflx
	Array of 2D ocean surface fluxes sent to CPL buffer.
type(meshfield3d), dimension(:), allocatable	phy_tend
	Array of tendency variables with physics.
type(modelvarmanager)	phytends_manager
	Object to manage tendency variables with physics.
integer	phytends_commid
integer	phytend_num_tot
	Total number of tendency variables with physics.
integer	hist_comp_id = -1
	Component ID for history file.
type(file_restart_meshfield_component)	restart_file
	Object to manage restart file for ocean component.

Detailed Description

Derived type to manage variables with ocean component.

Definition at line 59 of file mod_ocean_vars.F90.

Member Function/Subroutine Documentation

◆ init()

procedure mod_ocean_vars::oceanvars::init	(	class(oceanvars), intent(inout), target	this,
		class(oceanmesh), intent(inout), target	ocean_mesh )

Setup an object to manage variables with ocean component.

Parameters

model_mesh Object to manage computational mesh of ocean model

Definition at line 96 of file mod_ocean_vars.F90.

◆ final()

procedure mod_ocean_vars::oceanvars::final ( class(oceanvars), intent(inout) this )

Finalize an object to manage variables with ocean component.

Definition at line 97 of file mod_ocean_vars.F90.

◆ history()

procedure mod_ocean_vars::oceanvars::history ( class(oceanvars), intent(inout), target this )

Put data with oceanic variables to history file.

Definition at line 98 of file mod_ocean_vars.F90.

◆ read_restart_file()

procedure mod_ocean_vars::oceanvars::read_restart_file	(	class(oceanvars), intent(inout), target	this,
		class(oceanmesh), intent(in)	ocean_mesh )

Read data with oceanic variables from restart file.

Definition at line 99 of file mod_ocean_vars.F90.

◆ write_restart_file_prep()

procedure mod_ocean_vars::oceanvars::write_restart_file_prep ( class(oceanvars), intent(inout) this )

Write data with oceanic variables to restart file.

Definition at line 100 of file mod_ocean_vars.F90.

◆ write_restart_file()

procedure mod_ocean_vars::oceanvars::write_restart_file ( class(oceanvars), intent(inout) this )

Write data with oceanic variables to restart file.

Definition at line 101 of file mod_ocean_vars.F90.

◆ write_restart_file_post()

procedure mod_ocean_vars::oceanvars::write_restart_file_post ( class(oceanvars), intent(inout) this )

Close restart file for oceanic variables.

Definition at line 102 of file mod_ocean_vars.F90.

References mod_ocean_vars::oceanvars_getlocalmeshprgvars().

Member Data Documentation

◆ mesh

class(oceanmesh), pointer mod_ocean_vars::oceanvars::mesh

Pointer to an object to manage a primary mesh for ocean component.

Definition at line 60 of file mod_ocean_vars.F90.

60 class(OceanMesh), pointer :: mesh !< Pointer to an object to manage a primary mesh for ocean component

◆ prog_vars

type(meshfield3d), dimension(:), allocatable mod_ocean_vars::oceanvars::prog_vars

Array of 3D prognostic variables.

Definition at line 63 of file mod_ocean_vars.F90.

63 type(MeshField3D), allocatable :: PROG_VARS(:) !< Array of 3D prognostic variables

◆ progvars_manager

type(modelvarmanager) mod_ocean_vars::oceanvars::progvars_manager

An object to manage prognostic variables.

Definition at line 64 of file mod_ocean_vars.F90.

64 type(ModelVarManager) :: PROGVARS_manager !< An object to manage prognostic variables

◆ qtrc_vars

type(meshfield3d), dimension(:), allocatable mod_ocean_vars::oceanvars::qtrc_vars

Array of 3D tracer variables.

Definition at line 67 of file mod_ocean_vars.F90.

67 type(MeshField3D), allocatable :: QTRC_VARS(:) !< Array of 3D tracer variables

◆ qtrcvars_manager

type(modelvarmanager) mod_ocean_vars::oceanvars::qtrcvars_manager

An object to manage tracer variables.

Definition at line 68 of file mod_ocean_vars.F90.

68 type(ModelVarManager) :: QTRCVARS_manager !< An object to manage tracer variables

◆ aux_vars

type(meshfield3d), dimension(:), allocatable mod_ocean_vars::oceanvars::aux_vars

Array of 3D auxiliary variables.

Definition at line 71 of file mod_ocean_vars.F90.

71 type(MeshField3D), allocatable :: AUX_VARS(:) !< Array of 3D auxiliary variables

◆ auxvars_manager

type(modelvarmanager) mod_ocean_vars::oceanvars::auxvars_manager

Object to manage 3D auxiliary variables.

Definition at line 72 of file mod_ocean_vars.F90.

72 type(ModelVarManager) :: AUXVARS_manager !< Object to manage 3D auxiliary variables

◆ aux_vars2d

type(meshfield2d), dimension(:), allocatable mod_ocean_vars::oceanvars::aux_vars2d

Array of 2D auxiliary variables.

Definition at line 75 of file mod_ocean_vars.F90.

75 type(MeshField2D), allocatable :: AUX_VARS2D(:) !< Array of 2D auxiliary variables

◆ auxvars2d_manager

type(modelvarmanager) mod_ocean_vars::oceanvars::auxvars2d_manager

An object to manage 2D auxiliary variables.

Definition at line 76 of file mod_ocean_vars.F90.

76 type(ModelVarManager) :: AUXVARS2D_manager !< An object to manage 2D auxiliary variables

◆ atm_vars2d

type(meshfield2d), dimension(:), allocatable mod_ocean_vars::oceanvars::atm_vars2d

Array of 2D atmospheric variables.

Definition at line 79 of file mod_ocean_vars.F90.

79 type(MeshField2D), allocatable :: ATM_VARS2D(:) !< Array of 2D atmospheric variables

◆ ocn_sflx

type(meshfield2d), dimension(:), allocatable mod_ocean_vars::oceanvars::ocn_sflx

Array of 2D ocean surface fluxes sent to CPL buffer.

Definition at line 82 of file mod_ocean_vars.F90.

82 type(MeshField2D), allocatable :: OCN_SFLX(:) !< Array of 2D ocean surface fluxes sent to CPL buffer

◆ phy_tend

type(meshfield3d), dimension(:), allocatable mod_ocean_vars::oceanvars::phy_tend

Array of tendency variables with physics.

Definition at line 85 of file mod_ocean_vars.F90.

85 type(MeshField3D), allocatable :: PHY_TEND(:) !< Array of tendency variables with physics

◆ phytends_manager

type(modelvarmanager) mod_ocean_vars::oceanvars::phytends_manager

Object to manage tendency variables with physics.

Definition at line 86 of file mod_ocean_vars.F90.

86 type(ModelVarManager) :: PHYTENDS_manager !< Object to manage tendency variables with physics

◆ phytends_commid

integer mod_ocean_vars::oceanvars::phytends_commid

Definition at line 87 of file mod_ocean_vars.F90.

87 integer :: PHYTENDS_commID

◆ phytend_num_tot

integer mod_ocean_vars::oceanvars::phytend_num_tot

Total number of tendency variables with physics.

Definition at line 88 of file mod_ocean_vars.F90.

88 integer :: PHYTEND_NUM_TOT !< Total number of tendency variables with physics

◆ hist_comp_id

integer mod_ocean_vars::oceanvars::hist_comp_id = -1

Component ID for history file.

Definition at line 91 of file mod_ocean_vars.F90.

91 integer :: hist_comp_id = -1 !< Component ID for history file

◆ restart_file

type(file_restart_meshfield_component) mod_ocean_vars::oceanvars::restart_file

Object to manage restart file for ocean component.

Definition at line 94 of file mod_ocean_vars.F90.

94 type(FILE_restart_meshfield_component) :: restart_file !< Object to manage restart file for ocean component

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

mod_ocean_vars.F90

Public Member Functions

Public Attributes