SOCA
Public Attributes | Related Functions | List of all members
soca_model_mod::soca_model Type Reference

Fortran derived type to hold configuration data for the model. More...

Collaboration diagram for soca_model_mod::soca_model:
Collaboration graph
[legend]

Public Member Functions

constructor/destructor
procedure setup => soca_model_setup
 Initialize model's data structure. More...
 
procedure delete => soca_model_delete
 Release memory. More...
 
model run steps
procedure init => soca_model_init
 Prepare MOM6 integration. More...
 
procedure propagate => soca_model_propagate
 Advance MOM6 one baroclinic time step. More...
 
procedure finalize => soca_model_finalize
 Finalize MOM6 integration: Update mom6's state and checkpoint. More...
 

Public Attributes

integer advance_mom6
 call mom6 step if true More...
 
real(kind=kind_real) dt0
 dimensional time (seconds) More...
 
type(soca_mom6_config) mom6_config
 MOM6 data structure. More...
 
real(kind_real), dimension(2) tocn_minmax
 
real(kind_real), dimension(2) socn_minmax
 min, max values More...
 

Related Functions

(Note that these are not member functions.)

subroutine soca_model_setup (self, geom)
 Initialize model's data structure. More...
 
subroutine soca_model_init (self, flds)
 Prepare MOM6 integration. More...
 
subroutine soca_model_propagate (self, flds, fldsdate)
 Advance MOM6 one baroclinic time step. More...
 
subroutine soca_model_finalize (self, flds)
 Finalize MOM6 integration: Update mom6's state and checkpoint. More...
 
subroutine soca_model_delete (self)
 Release memory. More...
 

Detailed Description

Fortran derived type to hold configuration data for the model.

Definition at line 35 of file soca_model_mod.F90.

Member Function/Subroutine Documentation

◆ delete()

procedure soca_model_mod::soca_model::delete

Release memory.

See also
soca_model_delete

Definition at line 50 of file soca_model_mod.F90.

◆ finalize()

procedure soca_model_mod::soca_model::finalize

Finalize MOM6 integration: Update mom6's state and checkpoint.

See also
soca_model_finalize

Definition at line 64 of file soca_model_mod.F90.

◆ init()

procedure soca_model_mod::soca_model::init

Prepare MOM6 integration.

See also
soca_model_init

Definition at line 58 of file soca_model_mod.F90.

◆ propagate()

procedure soca_model_mod::soca_model::propagate

Advance MOM6 one baroclinic time step.

See also
soca_model_propagate

Definition at line 61 of file soca_model_mod.F90.

◆ setup()

procedure soca_model_mod::soca_model::setup

Initialize model's data structure.

See also
soca_model_setup

Definition at line 47 of file soca_model_mod.F90.

Friends And Related Function Documentation

◆ soca_model_delete()

subroutine soca_model_delete ( class(soca_model), intent(inout)  self)
related

Release memory.

Definition at line 282 of file soca_model_mod.F90.

Here is the call graph for this function:

◆ soca_model_finalize()

subroutine soca_model_finalize ( class(soca_model), intent(inout)  self,
type(soca_state), intent(inout)  flds 
)
related

Finalize MOM6 integration: Update mom6's state and checkpoint.

Definition at line 233 of file soca_model_mod.F90.

◆ soca_model_init()

subroutine soca_model_init ( class(soca_model), intent(inout)  self,
type(soca_state), intent(inout)  flds 
)
related

Prepare MOM6 integration.

Parameters
[in,out]fldsinitial condition

Definition at line 94 of file soca_model_mod.F90.

◆ soca_model_propagate()

subroutine soca_model_propagate ( class(soca_model), intent(inout)  self,
type(soca_state), intent(inout)  flds,
type(datetime), intent(in)  fldsdate 
)
related

Advance MOM6 one baroclinic time step.

Definition at line 149 of file soca_model_mod.F90.

Here is the call graph for this function:

◆ soca_model_setup()

subroutine soca_model_setup ( class(soca_model), intent(inout)  self,
type(soca_geom), intent(in)  geom 
)
related

Initialize model's data structure.

Parameters
[in]geommodel geometry

Definition at line 80 of file soca_model_mod.F90.

Here is the call graph for this function:

Member Data Documentation

◆ advance_mom6

integer soca_model_mod::soca_model::advance_mom6

call mom6 step if true

Definition at line 36 of file soca_model_mod.F90.

◆ dt0

real(kind=kind_real) soca_model_mod::soca_model::dt0

dimensional time (seconds)

Definition at line 37 of file soca_model_mod.F90.

◆ mom6_config

type(soca_mom6_config) soca_model_mod::soca_model::mom6_config

MOM6 data structure.

Definition at line 38 of file soca_model_mod.F90.

◆ socn_minmax

real(kind_real), dimension(2) soca_model_mod::soca_model::socn_minmax

min, max values

Definition at line 39 of file soca_model_mod.F90.

◆ tocn_minmax

real(kind_real), dimension(2) soca_model_mod::soca_model::tocn_minmax

Definition at line 39 of file soca_model_mod.F90.

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