Public Member Functions | List of all members
ConsecutiveSnapshots Class Reference

A diagnostic class that writes snapshots at regular intervals. More...

#include <consecutive_snapshots.hpp>

Inheritance diagram for ConsecutiveSnapshots:
Inheritance graph
[legend]
Collaboration diagram for ConsecutiveSnapshots:
Collaboration graph
[legend]

Public Member Functions

 ConsecutiveSnapshots (Trigger *trigger, Index2FileName *i2fn)
 Class constructor. More...
 
 ConsecutiveSnapshots (Trigger *trigger, Index2FileName *i2fn, const vector< DiagnosticAppendix *> &appendices)
 Class constructor. More...
 
void operator() (const hdsim &sim)
 Perform diagnostics. More...
 

Detailed Description

A diagnostic class that writes snapshots at regular intervals.

Definition at line 16 of file consecutive_snapshots.hpp.

Constructor & Destructor Documentation

◆ ConsecutiveSnapshots() [1/2]

ConsecutiveSnapshots::ConsecutiveSnapshots ( Trigger trigger,
Index2FileName i2fn 
)

Class constructor.

Parameters
triggerTrigger function
i2fnFunction for choosing file names

Definition at line 6 of file consecutive_snapshots.cpp.

◆ ConsecutiveSnapshots() [2/2]

ConsecutiveSnapshots::ConsecutiveSnapshots ( Trigger trigger,
Index2FileName i2fn,
const vector< DiagnosticAppendix *> &  appendices 
)

Class constructor.

Parameters
triggerTrigger function
i2fnFunction for choosing file names
appendicesAdditional data to be written to snapshot

Definition at line 10 of file consecutive_snapshots.cpp.

Member Function Documentation

◆ operator()()

void ConsecutiveSnapshots::operator() ( const hdsim sim)
virtual

Perform diagnostics.

Parameters
simHydrodynamic simulation

Implements DiagnosticFunction.

Definition at line 15 of file consecutive_snapshots.cpp.

Here is the call graph for this function:

The documentation for this class was generated from the following files: