faunus
Public Member Functions | List of all members
Faunus::analysis::CombinedAnalysis Class Reference

Aggregator class for storing and selecting multiple analysis instances. More...

#include <analysis.h>

Inheritance diagram for Faunus::analysis::CombinedAnalysis:
Inheritance graph
[legend]
Collaboration diagram for Faunus::analysis::CombinedAnalysis:
Collaboration graph
[legend]

Public Member Functions

 CombinedAnalysis (const json &json_array, Space &spc, Energy::Hamiltonian &pot)
 
void sample ()
 
void to_disk ()
 prompt all analysis to save to disk if appropriate
 
- Public Member Functions inherited from Faunus::BasePointerVector< Analysis >
auto begin () noexcept
 
auto begin () const noexcept
 
auto end () noexcept
 
auto end () const noexcept
 
auto empty () const noexcept
 
auto size () const noexcept
 
auto & back () noexcept
 
auto & back () const noexcept
 
auto & front () noexcept
 
auto & front () const noexcept
 
auto & at (size_t n)
 
auto & at (size_t n) const
 
void emplace_back (Args &... args)
 Create an (derived) instance and append a pointer to it to the vector.
 
void emplace_back (const Args &... args)
 Create an (derived) instance and append a pointer to it to the vector.
 
auto & push_back (value_type arg)
 Append a pointer to a (derived) instance to the vector.
 
auto & operator= (const BasePointerVector< Tderived > &d)
 Allow assignment to a vector of ancestors.
 
auto find () const
 Pointer list to all matching type.
 
std::shared_ptr< Tderived > findFirstOf () const
 

Additional Inherited Members

- Public Types inherited from Faunus::BasePointerVector< Analysis >
using value_type = std::shared_ptr< Analysis >
 
- Public Attributes inherited from Faunus::BasePointerVector< Analysis >
std::vector< value_type > vec
 Vector of shared pointers to base class.
 

Detailed Description

Aggregator class for storing and selecting multiple analysis instances.

Holds an arbitrary number of analysis instances and selects them at random, based on user input. This is typically called from the main simulation loop.


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