Skip to content

Commit

Permalink
Improve OutputManager function descriptions
Browse files Browse the repository at this point in the history
  • Loading branch information
tcclevenger committed Oct 17, 2024
1 parent 9054ca7 commit 77602fe
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions components/eamxx/src/share/io/scream_output_manager.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,8 @@ class OutputManager
OutputManager() = default;
virtual ~OutputManager ();

// Initialize
// Initialize manager by storing class members that only depend on runtime parameters.
// Inputs:
// - params: the parameter list with file/fields info, as well as method of output options
// - run_t0: the timestamp of the start of the current simulation
// - case_t0: the timestamp of the start of the overall simulation (precedes run_r0 for
Expand All @@ -86,7 +87,7 @@ class OutputManager
initialize(io_comm, params, run_t0, run_t0, is_model_restart_output);
}

// Set up the manager, creating all output streams.
// Setup manager by creating the internal output streams using grids/field data
// Inputs:
// - field_mgr/field_mgrs: field manager(s) storing fields to be outputed
// - grids_mgr: grid manager to create remapping from field managers grids onto the IO grid.
Expand Down

0 comments on commit 77602fe

Please sign in to comment.