Reports the maximum horizontal absolute velocity component over the grid. More...
Inheritance diagram for pism::diagnostics::scalar::MaxHorizontalVelocity:Public Member Functions | |
| MaxHorizontalVelocity (const IceModel *m) | |
| double | compute () |
| Public Member Functions inherited from pism::TSDiag< TSSnapshotDiagnostic, IceModel > | |
| TSDiag (const IceModel *m, const std::string &name) | |
| Public Member Functions inherited from pism::TSSnapshotDiagnostic | |
| TSSnapshotDiagnostic (std::shared_ptr< const Grid > g, const std::string &name) | |
| Public Member Functions inherited from pism::TSDiagnostic | |
| TSDiagnostic (std::shared_ptr< const Grid > g, const std::string &name) | |
| virtual | ~TSDiagnostic () |
| void | update (double t0, double t1) |
| void | flush () |
| void | init (const File &output_file, std::shared_ptr< std::vector< double > > requested_times) |
| const VariableMetadata & | metadata () const |
Additional Inherited Members | |
| Public Types inherited from pism::TSDiagnostic | |
| typedef std::shared_ptr< TSDiagnostic > | Ptr |
| Protected Member Functions inherited from pism::TSDiagnostic | |
| void | set_units (const std::string &units, const std::string &output_units) |
| Protected Attributes inherited from pism::TSDiag< TSSnapshotDiagnostic, IceModel > | |
| const IceModel * | model |
| Protected Attributes inherited from pism::TSDiagnostic | |
| std::shared_ptr< const Grid > | m_grid |
| the grid | |
| const Config::ConstPtr | m_config |
| Configuration flags and parameters. | |
| const units::System::Ptr | m_sys |
| the unit system | |
| std::string | m_time_name |
| time series object used to store computed values and metadata | |
| VariableMetadata | m_variable |
| VariableMetadata | m_dimension |
| VariableMetadata | m_time_bounds |
| std::vector< double > | m_time |
| std::vector< double > | m_bounds |
| std::vector< double > | m_values |
| std::shared_ptr< std::vector< double > > | m_requested_times |
| requested times | |
| unsigned int | m_current_time |
| index into m_times | |
| std::string | m_output_filename |
| unsigned int | m_start |
| starting index used when flushing the buffer | |
| size_t | m_buffer_size |
| size of the buffer used to store data | |
Detailed Description
Reports the maximum horizontal absolute velocity component over the grid.
This is the value used by the adaptive time-stepping code in the CFL condition for horizontal advection (i.e. in energy and mass conservation time steps).
This is not the maximum horizontal speed, but rather the maximum of components.
Note that this picks up the value computed during the time-step taken at a reporting time. (It is not the "average over the reporting interval computed using differencing in time", as other rate-of-change diagnostics.)
Definition at line 2164 of file diagnostics.cc.
The documentation for this class was generated from the following file:
- src/icemodel/diagnostics.cc
