SSAGES  0.8.3
Software Suite for Advanced General Ensemble Simulations
Public Member Functions | Private Attributes | List of all members
SSAGES::COPSS Class Reference

Wrapper class for COPSS simulations. More...

#include <COPSS.h>

Inheritance diagram for SSAGES::COPSS:
Inheritance graph

Public Member Functions

 COPSS (boost::mpi::communicator &comm, unsigned int frequency)
 Constructor. More...
void PreSimulation (Snapshot *, const CVList &) override
 Pre-Simulation Hook.
void PostIntegration (Snapshot *snapshot, const CVList &) override
 Post-Integration Hook.
void PostSimulation (Snapshot *, const CVList &) override
 Post-Simulation Hook.
void Serialize (Json::Value &) const override
 Serialize the class. More...
 ~COPSS ()
- Public Member Functions inherited from SSAGES::Constraint
 Constraint (unsigned int frequency, boost::mpi::communicator &comm)
 Constructor. More...
virtual ~Constraint ()
- Public Member Functions inherited from SSAGES::EventListener
 EventListener (unsigned int frequency)
 Constructor. More...
unsigned int GetFrequency () const
 Get frequency of event listener. More...
virtual void PreSimulation (Snapshot *snapshot, const class CVManager &cvmanager)=0
 Method call prior to simulation initiation. More...
virtual void PostIntegration (Snapshot *snapshot, const class CVManager &cvmanager)=0
 Method call post integration. More...
virtual void PostSimulation (Snapshot *snapshot, const class CVManager &cvmanager)=0
 Method call post simulation. More...
virtual ~EventListener ()

Private Attributes

std::ofstream myout_
 Output stream for debug output.

Additional Inherited Members

- Static Public Member Functions inherited from SSAGES::Constraint
static ConstraintBuildConstraint (const Json::Value &json, boost::mpi::communicator &comm)
 Build a constraint from a JSON node. More...
static ConstraintBuildConstraint (const Json::Value &json, boost::mpi::communicator &comm, const std::string &path)
 Overloaded function allowing JSON path specification. More...
static void BuildConstraint (const Json::Value &json, ConstraintList &clist, boost::mpi::communicator &comm, const std::string &path)
 Build constraint. More...
- Protected Attributes inherited from SSAGES::Constraint
boost::mpi::communicator comm_
 MPI global communicator.

Detailed Description

Wrapper class for COPSS simulations.

Definition at line 32 of file COPSS.h.

Constructor & Destructor Documentation


SSAGES::COPSS::COPSS ( boost::mpi::communicator &  comm,
unsigned int  frequency 


commMPI global communicator.
frequencyFrequency with which this constraint is called.

Definition at line 44 of file COPSS.h.

45  :
46  Constraint(frequency, comm)
47  {
49  }
std::ofstream myout_
Output stream for debug output.
Definition: COPSS.h:36
Constraint(unsigned int frequency, boost::mpi::communicator &comm)
Definition: Constraint.h:55

Member Function Documentation

◆ Serialize()

void SSAGES::COPSS::Serialize ( Json::Value &  ) const

Serialize the class.

Serialization not yet implemented.

Definition at line 82 of file COPSS.h.

83  {
85  }

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