mod_ocean_dyn::oceandyn Type Reference

Derived type to manage a component of oceanic dynamics. More...

Inheritance diagram for mod_ocean_dyn::oceandyn:

Public Member Functions
procedure, public	setup (this, model_mesh, tm_parent_comp)
	Setup an object to manage a component of oceanic dynamics.
procedure, public	calc_tendency (this, model_mesh, prgvars_list, trcvars_list, auxvars_list, forcing_list, is_update)
	Calculate tendencies associated with oceanic dynamics.
procedure, public	update (this, model_mesh, prgvars_list, trcvars_list, auxvars_list, forcing_list, is_update)
	Update variables with a component of oceanic dynamics The tendencies with oceanic dynamical cores are evaluated and the prognostic variables is updated.
procedure, public	finalize (this)
	Finalize an object to manage a component of oceanic dynamics.
Public Member Functions inherited from scale_model_component_proc::modelcomponentproc
procedure(modelcomponentproc_setup), deferred, public	setup modelcomponentproc_setup
procedure(modelcomponentproc_calc_tendency), deferred, public	calc_tendency modelcomponentproc_calc_tendency
procedure(modelcomponentproc_update), deferred, public	update modelcomponentproc_update
procedure(modelcomponentproc_finalize), deferred, public	finalize modelcomponentproc_finalize
procedure, public	modelcomponentproc_init (this, name, is_activated)
procedure, public	isactivated (this)

Public Attributes
type(oceandynvars)	dyn_vars
	An object to manage variables in a component of oceanic dynamics.
integer	eqs_type
	Type of governing equations: 0=NONE, 1=SLAB.
class(meshbase3d), pointer	mesh3d
real(rp)	dtsec
	Timestep for a oceanic dynamical core.
Public Attributes inherited from scale_model_component_proc::modelcomponentproc
character(len=h_short)	name
integer	tm_process_id

Detailed Description

Derived type to manage a component of oceanic dynamics.

Definition at line 64 of file mod_ocean_dyn.F90.

Member Function/Subroutine Documentation

setup()

procedure, public mod_ocean_dyn::oceandyn::setup	(	class(oceandyn), intent(inout)	this,
		class(modelmeshbase), intent(in), target	model_mesh,
		class(time_manager_component), intent(inout)	tm_parent_comp )

Setup an object to manage a component of oceanic dynamics.

Parameters

model_mesh	Object to manage computational mesh of oceanic model
tm_parent_comp	Object to mange a temporal scheme in a parent component

Definition at line 73 of file mod_ocean_dyn.F90.

calc_tendency()

procedure, public mod_ocean_dyn::oceandyn::calc_tendency	(	class(oceandyn), intent(inout)	this,
		class(modelmeshbase), intent(in)	model_mesh,
		class(modelvarmanager), intent(inout)	prgvars_list,
		class(modelvarmanager), intent(inout)	trcvars_list,
		class(modelvarmanager), intent(inout)	auxvars_list,
		class(modelvarmanager), intent(inout)	forcing_list,
		logical, intent(in)	is_update )

Calculate tendencies associated with oceanic dynamics.

Because the tendencies with oceanic dynamical cores are treated in OceanDyn_update, no calculation is performed in this subroutine.

Parameters

model_mesh	Object to manage computational mesh of oceanic model
prgvars_list	Object to mange prognostic variables with oceanic dynamical core
trcvars_list	Object to mange auxiliary variables
forcing_list	Object to mange forcing terms
is_update	Flag to specify whether the tendencies are updated in this call

Definition at line 74 of file mod_ocean_dyn.F90.

update()

procedure, public mod_ocean_dyn::oceandyn::update	(	class(oceandyn), intent(inout)	this,
		class(modelmeshbase), intent(in)	model_mesh,
		class(modelvarmanager), intent(inout)	prgvars_list,
		class(modelvarmanager), intent(inout)	trcvars_list,
		class(modelvarmanager), intent(inout)	auxvars_list,
		class(modelvarmanager), intent(inout)	forcing_list,
		logical, intent(in)	is_update )

Update variables with a component of oceanic dynamics The tendencies with oceanic dynamical cores are evaluated and the prognostic variables is updated.

Parameters

model_mesh	Object to manage computational mesh of oceanic model
prgvars_list	Object to mange prognostic variables with oceanic dynamical core
trcvars_list	Object to mange auxiliary variables
forcing_list	Object to mange forcing terms
is_update	Flag to speicfy whether the tendencies are updated in this call

Definition at line 75 of file mod_ocean_dyn.F90.

finalize()

procedure, public mod_ocean_dyn::oceandyn::finalize

(

class(oceandyn), intent(inout)

this

)

Finalize an object to manage a component of oceanic dynamics.

Definition at line 76 of file mod_ocean_dyn.F90.

Member Data Documentation

dyn_vars

type(oceandynvars) mod_ocean_dyn::oceandyn::dyn_vars

An object to manage variables in a component of oceanic dynamics.

Definition at line 67 of file mod_ocean_dyn.F90.

    type(OceanDynVars) :: dyn_vars                     !< An object to manage variables in a component of oceanic dynamics

eqs_type

integer mod_ocean_dyn::oceandyn::eqs_type

Type of governing equations: 0=NONE, 1=SLAB.

Definition at line 68 of file mod_ocean_dyn.F90.

    integer :: eqs_type                                !< Type of governing equations: 0=NONE, 1=SLAB

mesh3d

class(meshbase3d), pointer mod_ocean_dyn::oceandyn::mesh3d

Definition at line 70 of file mod_ocean_dyn.F90.

    class(MeshBase3D), pointer :: mesh3D

dtsec

real(rp) mod_ocean_dyn::oceandyn::dtsec

Timestep for a oceanic dynamical core.

Definition at line 71 of file mod_ocean_dyn.F90.

    real(RP) :: dtsec                                  !< Timestep for a oceanic dynamical core

---

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

• mod_ocean_dyn.F90