mom_database_comms module reference

Contains routines necessary to initialize communication with a database.

More…

Data Types

dbcomms_cs_type

Control structure to store Database communication related parameters and objects.

Functions/Subroutines

database_comms_init()

Detailed Description

Contains routines necessary to initialize communication with a database.

Type Documentation

type  mom_database_comms/dbcomms_cs_type

Control structure to store Database communication related parameters and objects.

Type fields:
  • % client :: type(dbclient_type) The Database client itself.

  • % use_dbclient :: logical If True, use Database within MOM6.

  • % colocated :: logical If True, the orchestrator was setup in ‘co-located’ mode.

  • % cluster :: logical If True, the orchestrator has three shards or more.

  • % colocated_stride :: integer Sets which ranks will load the model from the file e.g. mod(rank,colocated_stride) == 0.

[source]

Function/Subroutine Documentation

subroutine mom_database_comms/database_comms_init(param_file, CS, client_in)
Parameters:
  • param_file :: param_file [in] Parameter file structure

  • cs :: [inout] Control structure for Database

  • client_in :: client_in [in] If present, use a previously initialized Database client

Call to:

mom_error_handler::mom_error

Called from:

mom::initialize_mom

[source]

[source]