MUQ  0.4.3
Public Member Functions | List of all members
muq::SamplingAlgorithms::CollectorClient Class Reference

High-level communication wrapper for controlling SampleCollectors. More...

#include <ParallelMIMCMCWorker.h>

Detailed Description

High-level communication wrapper for controlling SampleCollectors.

This takes care about assigning workers to a set of collectors for a specific model index/level, sending commands to them and finally unassigning them again.

Definition at line 34 of file ParallelMIMCMCWorker.h.

Public Member Functions

 CollectorClient (std::shared_ptr< parcer::Communicator > comm, std::vector< int > subgroup, std::shared_ptr< MultiIndex > modelindex)
 
std::shared_ptr< MultiIndex > GetModelIndex () const
 
void CollectSamples (int numSamples)
 
void ComputeMeans ()
 
void WriteToFile (std::string filename)
 
bool Receive (ControlFlag command, const MPI_Status &status)
 
Eigen::VectorXd GetQOIMean ()
 
void Unassign ()
 
bool IsSampling ()
 
bool IsComputingMeans ()
 

Constructor & Destructor Documentation

◆ CollectorClient()

CollectorClient::CollectorClient ( std::shared_ptr< parcer::Communicator >  comm,
std::vector< int >  subgroup,
std::shared_ptr< MultiIndex >  modelindex 
)

Definition at line 19 of file ParallelMIMCMCWorker.cpp.

References muq::SamplingAlgorithms::ASSIGN_COLLECTOR, boxHighestIndex, boxIndices, boxLowestIndex, comm, muq::SamplingAlgorithms::ControlTag, and subgroup.

Member Function Documentation

◆ CollectSamples()

void CollectorClient::CollectSamples ( int  numSamples)

Definition at line 44 of file ParallelMIMCMCWorker.cpp.

References comm, muq::SamplingAlgorithms::ControlTag, muq::SamplingAlgorithms::SAMPLE_BOX, sampling, and subgroup.

◆ ComputeMeans()

void CollectorClient::ComputeMeans ( )

Definition at line 60 of file ParallelMIMCMCWorker.cpp.

References comm, computingMeans, muq::SamplingAlgorithms::ControlTag, muq::SamplingAlgorithms::MEANS, and subgroup.

◆ GetModelIndex()

std::shared_ptr< MultiIndex > CollectorClient::GetModelIndex ( ) const

Definition at line 38 of file ParallelMIMCMCWorker.cpp.

References boxHighestIndex.

◆ GetQOIMean()

Eigen::VectorXd CollectorClient::GetQOIMean ( )

Definition at line 119 of file ParallelMIMCMCWorker.cpp.

References boxQOIMean.

◆ IsComputingMeans()

bool CollectorClient::IsComputingMeans ( )

Definition at line 133 of file ParallelMIMCMCWorker.cpp.

References computingMeans.

◆ IsSampling()

bool CollectorClient::IsSampling ( )

Definition at line 129 of file ParallelMIMCMCWorker.cpp.

References sampling.

◆ Receive()

bool CollectorClient::Receive ( ControlFlag  command,
const MPI_Status &  status 
)

Definition at line 77 of file ParallelMIMCMCWorker.cpp.

References boxHighestIndex, boxIndices, boxLowestIndex, boxQOIMean, comm, computingMeans, muq::SamplingAlgorithms::ControlTag, muq::SamplingAlgorithms::MEANS_DONE, muq::SamplingAlgorithms::SAMPLE_BOX_DONE, sampling, and subgroup.

◆ Unassign()

void CollectorClient::Unassign ( )

Definition at line 123 of file ParallelMIMCMCWorker.cpp.

References comm, muq::SamplingAlgorithms::ControlTag, subgroup, and muq::SamplingAlgorithms::UNASSIGN.

◆ WriteToFile()

void CollectorClient::WriteToFile ( std::string  filename)

Definition at line 68 of file ParallelMIMCMCWorker.cpp.

References comm, muq::SamplingAlgorithms::ControlTag, subgroup, and muq::SamplingAlgorithms::WRITE_TO_FILE.

Member Data Documentation

◆ boxHighestIndex

std::shared_ptr<MultiIndex> muq::SamplingAlgorithms::CollectorClient::boxHighestIndex
private

Definition at line 68 of file ParallelMIMCMCWorker.h.

Referenced by CollectorClient(), GetModelIndex(), and Receive().

◆ boxIndices

std::shared_ptr<MultiIndexSet> muq::SamplingAlgorithms::CollectorClient::boxIndices
private

Definition at line 65 of file ParallelMIMCMCWorker.h.

Referenced by CollectorClient(), and Receive().

◆ boxLowestIndex

std::shared_ptr<MultiIndex> muq::SamplingAlgorithms::CollectorClient::boxLowestIndex
private

Definition at line 69 of file ParallelMIMCMCWorker.h.

Referenced by CollectorClient(), and Receive().

◆ boxQOIMean

Eigen::VectorXd muq::SamplingAlgorithms::CollectorClient::boxQOIMean
private

Definition at line 66 of file ParallelMIMCMCWorker.h.

Referenced by GetQOIMean(), and Receive().

◆ comm

std::shared_ptr<parcer::Communicator> muq::SamplingAlgorithms::CollectorClient::comm
private

Definition at line 60 of file ParallelMIMCMCWorker.h.

Referenced by CollectorClient(), CollectSamples(), ComputeMeans(), Receive(), Unassign(), and WriteToFile().

◆ computingMeans

bool muq::SamplingAlgorithms::CollectorClient::computingMeans = false
private

Definition at line 64 of file ParallelMIMCMCWorker.h.

Referenced by ComputeMeans(), IsComputingMeans(), and Receive().

◆ means

std::map<std::shared_ptr<MultiIndex>, Eigen::VectorXd, MultiPtrComp> muq::SamplingAlgorithms::CollectorClient::means
private

Definition at line 71 of file ParallelMIMCMCWorker.h.

◆ sampling

bool muq::SamplingAlgorithms::CollectorClient::sampling = false
private

Definition at line 63 of file ParallelMIMCMCWorker.h.

Referenced by CollectSamples(), IsSampling(), and Receive().

◆ subgroup

std::vector<int> muq::SamplingAlgorithms::CollectorClient::subgroup
private

Definition at line 61 of file ParallelMIMCMCWorker.h.

Referenced by CollectorClient(), CollectSamples(), ComputeMeans(), Receive(), Unassign(), and WriteToFile().

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