MOM6
neverland_surface_forcing::neverland_surface_forcing_cs Type Reference

Detailed Description

This control structure should be used to store any run-time variables associated with the Neverland forcing.

It can be readily modified for a specific case, and because it is private there will be no changes needed in other code (although they will have to be recompiled).

Definition at line 30 of file Neverland_surface_forcing.F90.

Collaboration diagram for neverland_surface_forcing::neverland_surface_forcing_cs:
[legend]

Public variables and constants

logical use_temperature
 If true, use temperature and salinity. More...
 
logical restorebuoy
 If true, use restoring surface buoyancy forcing. More...
 
real rho0
 The density used in the Boussinesq approximation [R ~> kg m-3]. More...
 
real g_earth
 The gravitational acceleration [L2 Z-1 T-2 ~> m s-2]. More...
 
real flux_const
 The restoring rate at the surface [Z T-1 ~> m s-1]. More...
 
real, dimension(:,:), pointer buoy_restore => NULL()
 The pattern to restore buoyancy to. More...
 
character(len=200) inputdir
 The directory where NetCDF input files are. More...
 
type(diag_ctrl), pointer diag
 A structure that is used to regulate the timing of diagnostic output. More...
 
logical first_call = .true.
 True until Neverland_buoyancy_forcing has been called. More...
 

Variables and constants

◆ buoy_restore

real, dimension(:,:), pointer neverland_surface_forcing::neverland_surface_forcing_cs::buoy_restore => NULL()

The pattern to restore buoyancy to.

Definition at line 37 of file Neverland_surface_forcing.F90.

37  real, dimension(:,:), pointer :: &
38  buoy_restore(:,:) => null() !< The pattern to restore buoyancy to.

◆ diag

type(diag_ctrl), pointer neverland_surface_forcing::neverland_surface_forcing_cs::diag

A structure that is used to regulate the timing of diagnostic output.

Definition at line 40 of file Neverland_surface_forcing.F90.

40  type(diag_ctrl), pointer :: diag !< A structure that is used to regulate the

◆ first_call

logical neverland_surface_forcing::neverland_surface_forcing_cs::first_call = .true.

True until Neverland_buoyancy_forcing has been called.

Definition at line 42 of file Neverland_surface_forcing.F90.

42  logical :: first_call = .true. !< True until Neverland_buoyancy_forcing has been called

◆ flux_const

real neverland_surface_forcing::neverland_surface_forcing_cs::flux_const

The restoring rate at the surface [Z T-1 ~> m s-1].

Definition at line 36 of file Neverland_surface_forcing.F90.

36  real :: flux_const !< The restoring rate at the surface [Z T-1 ~> m s-1].

◆ g_earth

real neverland_surface_forcing::neverland_surface_forcing_cs::g_earth

The gravitational acceleration [L2 Z-1 T-2 ~> m s-2].

Definition at line 35 of file Neverland_surface_forcing.F90.

35  real :: G_Earth !< The gravitational acceleration [L2 Z-1 T-2 ~> m s-2].

◆ inputdir

character(len=200) neverland_surface_forcing::neverland_surface_forcing_cs::inputdir

The directory where NetCDF input files are.

Definition at line 39 of file Neverland_surface_forcing.F90.

39  character(len=200) :: inputdir !< The directory where NetCDF input files are.

◆ restorebuoy

logical neverland_surface_forcing::neverland_surface_forcing_cs::restorebuoy

If true, use restoring surface buoyancy forcing.

Definition at line 33 of file Neverland_surface_forcing.F90.

33  logical :: restorebuoy !< If true, use restoring surface buoyancy forcing.

◆ rho0

real neverland_surface_forcing::neverland_surface_forcing_cs::rho0

The density used in the Boussinesq approximation [R ~> kg m-3].

Definition at line 34 of file Neverland_surface_forcing.F90.

34  real :: Rho0 !< The density used in the Boussinesq approximation [R ~> kg m-3].

◆ use_temperature

logical neverland_surface_forcing::neverland_surface_forcing_cs::use_temperature

If true, use temperature and salinity.

Definition at line 32 of file Neverland_surface_forcing.F90.

32  logical :: use_temperature !< If true, use temperature and salinity.

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