FE-Project
Loading...
Searching...
No Matches
mod_ocean_component::oceancomponent Type Reference

Derived type to manage oceanic component. More...

Inheritance diagram for mod_ocean_component::oceancomponent:
scale_model_component::modelcomponent

Public Member Functions

procedure, public setup (this)
 Setup an object to mange oceanic component.
procedure, public setup_vars (this)
 Setup variables with the oceanic component.
procedure, public set_coupler (this, coupler)
 Set coupler component to the oceanic component.
procedure, public calc_tendency (this, force)
 Calculate tendencies with the oceanic component.
procedure, public update (this)
 Update variables with the oceanic component.
procedure, public set_surface (this, countup)
 Set ocean quantities to coupler component.
procedure, public get_surface (this)
 Get atmospheric quantities from coupler component.
procedure, public finalize (this)
 Finalize an object to manage the ocean component.
Public Member Functions inherited from scale_model_component::modelcomponent
procedure(modelcomponent_setup), deferred, public setup modelcomponent_setup
procedure(modelcomponent_calc_tendency), deferred, public calc_tendency modelcomponent_calc_tendency
procedure(modelcomponent_update), deferred, public update modelcomponent_update
procedure(modelcomponent_finalize), deferred, public finalize modelcomponent_finalize
procedure, public modelcomponent_init (this, name, is_activated)
procedure, public isactivated (this)
procedure, public getcomponentname (this)

Public Attributes

type(oceanvars) vars
 Object to mange variables with oceanic component.
character(len=h_short) mesh_type
 Type name of mesh oceanic component.
class(oceanmesh), pointer mesh
 Pointer of mesh oceanic component.
type(oceanmeshrm) mesh_rm
 Object to manage mesh for the case of regional mode.
type(oceanmeshgm) mesh_gm
 Object to manage mesh for the case of global mode.
type(oceandyn) dyn_proc
 Object to manage dynamical process.
type(couplercomponent), pointer coupler_ptr
 Pointer of coupler component.
Public Attributes inherited from scale_model_component::modelcomponent
type(time_manager_component) time_manager

Detailed Description

Derived type to manage oceanic component.

Definition at line 69 of file mod_ocean_component.F90.

Member Function/Subroutine Documentation

◆ setup()

procedure, public mod_ocean_component::oceancomponent::setup ( class(oceancomponent), intent(inout), target this)

Setup an object to mange oceanic component.

Definition at line 81 of file mod_ocean_component.F90.

◆ setup_vars()

procedure, public mod_ocean_component::oceancomponent::setup_vars ( class(oceancomponent), intent(inout) this)

Setup variables with the oceanic component.

Definition at line 82 of file mod_ocean_component.F90.

◆ set_coupler()

procedure, public mod_ocean_component::oceancomponent::set_coupler ( class(oceancomponent), intent(inout) this,
class(couplercomponent), intent(inout), target coupler )

Set coupler component to the oceanic component.

Definition at line 83 of file mod_ocean_component.F90.

◆ calc_tendency()

procedure, public mod_ocean_component::oceancomponent::calc_tendency ( class(oceancomponent), intent(inout) this,
logical, intent(in) force )

Calculate tendencies with the oceanic component.

Definition at line 84 of file mod_ocean_component.F90.

◆ update()

procedure, public mod_ocean_component::oceancomponent::update ( class(oceancomponent), intent(inout) this)

Update variables with the oceanic component.

Definition at line 85 of file mod_ocean_component.F90.

◆ set_surface()

procedure, public mod_ocean_component::oceancomponent::set_surface ( class(oceancomponent), intent(inout) this,
logical, intent(in) countup )

Set ocean quantities to coupler component.

Definition at line 86 of file mod_ocean_component.F90.

◆ get_surface()

procedure, public mod_ocean_component::oceancomponent::get_surface ( class(oceancomponent), intent(inout) this)

Get atmospheric quantities from coupler component.

Definition at line 87 of file mod_ocean_component.F90.

◆ finalize()

procedure, public mod_ocean_component::oceancomponent::finalize ( class(oceancomponent), intent(inout) this)

Finalize an object to manage the ocean component.

Definition at line 88 of file mod_ocean_component.F90.

Member Data Documentation

◆ vars

type(oceanvars) mod_ocean_component::oceancomponent::vars

Object to mange variables with oceanic component.

Definition at line 70 of file mod_ocean_component.F90.

70 type(OceanVars) :: vars !< Object to mange variables with oceanic component

◆ mesh_type

character(len=h_short) mod_ocean_component::oceancomponent::mesh_type

Type name of mesh oceanic component.

Definition at line 72 of file mod_ocean_component.F90.

72 character(len=H_SHORT) :: mesh_type !< Type name of mesh oceanic component

◆ mesh

class(oceanmesh), pointer mod_ocean_component::oceancomponent::mesh

Pointer of mesh oceanic component.

Definition at line 73 of file mod_ocean_component.F90.

73 class(OceanMesh), pointer :: mesh !< Pointer of mesh oceanic component

◆ mesh_rm

type(oceanmeshrm) mod_ocean_component::oceancomponent::mesh_rm

Object to manage mesh for the case of regional mode.

Definition at line 74 of file mod_ocean_component.F90.

74 type(OceanMeshRM) :: mesh_rm !< Object to manage mesh for the case of regional mode

◆ mesh_gm

type(oceanmeshgm) mod_ocean_component::oceancomponent::mesh_gm

Object to manage mesh for the case of global mode.

Definition at line 75 of file mod_ocean_component.F90.

75 type(OceanMeshGM) :: mesh_gm !< Object to manage mesh for the case of global mode

◆ dyn_proc

type(oceandyn) mod_ocean_component::oceancomponent::dyn_proc

Object to manage dynamical process.

Definition at line 77 of file mod_ocean_component.F90.

77 type(OceanDyn) :: dyn_proc !< Object to manage dynamical process

◆ coupler_ptr

type(couplercomponent), pointer mod_ocean_component::oceancomponent::coupler_ptr

Pointer of coupler component.

Definition at line 79 of file mod_ocean_component.F90.

79 type(CouplerComponent), pointer :: coupler_ptr !< Pointer of coupler component

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