OPALX (Object Oriented Parallel Accelerator Library for Exascal) MINIorX
OPALX
SamplingBase Class Reference

#include <SamplingBase.hpp>

Inheritance diagram for SamplingBase:
Collaboration diagram for SamplingBase:

Public Member Functions

 SamplingBase (std::shared_ptr< ParticleContainer_t > &pc, std::shared_ptr< FieldContainer_t > &fc, std::shared_ptr< Distribution_t > &dist)
 SamplingBase (std::shared_ptr< ParticleContainer_t > &pc)
virtual ~SamplingBase ()
virtual void generateParticles (size_t &numberOfParticles, Vector_t< double, 3 > nr)
virtual void emitParticles (double t, double dt)
virtual void testNumEmitParticles (size_t nsteps, double dt)
virtual void testEmitParticles (size_t nsteps, double dt)
virtual void initDomainDecomp (double BoxIncr)
virtual void setWithDomainDecomp (bool withDomainDecomp)

Protected Attributes

std::shared_ptr< ParticleContainer_t > pc_m
std::shared_ptr< FieldContainer_t > fc_m
std::shared_ptr< Distribution_t > opalDist_m
std::string samplingMethod_m

Detailed Description

Definition at line 11 of file SamplingBase.hpp.

Constructor & Destructor Documentation

◆ SamplingBase() [1/2]

SamplingBase::SamplingBase ( std::shared_ptr< ParticleContainer_t > & pc,
std::shared_ptr< FieldContainer_t > & fc,
std::shared_ptr< Distribution_t > & dist )
inline

Definition at line 19 of file SamplingBase.hpp.

References fc_m, opalDist_m, and pc_m.

Referenced by FlatTop::FlatTop(), Gaussian::Gaussian(), Gaussian::Gaussian(), MultiVariateGaussian::MultiVariateGaussian(), MultiVariateGaussian::MultiVariateGaussian(), and MultiVariateGaussian::MultiVariateGaussian().

Here is the caller graph for this function:

◆ SamplingBase() [2/2]

SamplingBase::SamplingBase ( std::shared_ptr< ParticleContainer_t > & pc)
inline

Definition at line 23 of file SamplingBase.hpp.

References pc_m.

◆ ~SamplingBase()

virtual SamplingBase::~SamplingBase ( )
inlinevirtual

Definition at line 27 of file SamplingBase.hpp.

Member Function Documentation

◆ emitParticles()

virtual void SamplingBase::emitParticles ( double t,
double dt )
inlinevirtual

Reimplemented in FlatTop.

Definition at line 31 of file SamplingBase.hpp.

◆ generateParticles()

virtual void SamplingBase::generateParticles ( size_t & numberOfParticles,
Vector_t< double, 3 > nr )
inlinevirtual

Reimplemented in FlatTop, Gaussian, and MultiVariateGaussian.

Definition at line 29 of file SamplingBase.hpp.

References nr.

◆ initDomainDecomp()

virtual void SamplingBase::initDomainDecomp ( double BoxIncr)
inlinevirtual

Reimplemented in FlatTop.

Definition at line 39 of file SamplingBase.hpp.

◆ setWithDomainDecomp()

virtual void SamplingBase::setWithDomainDecomp ( bool withDomainDecomp)
inlinevirtual

Reimplemented in FlatTop.

Definition at line 41 of file SamplingBase.hpp.

◆ testEmitParticles()

virtual void SamplingBase::testEmitParticles ( size_t nsteps,
double dt )
inlinevirtual

Definition at line 37 of file SamplingBase.hpp.

◆ testNumEmitParticles()

virtual void SamplingBase::testNumEmitParticles ( size_t nsteps,
double dt )
inlinevirtual

Definition at line 34 of file SamplingBase.hpp.

Member Data Documentation

◆ fc_m

std::shared_ptr<FieldContainer_t> SamplingBase::fc_m
protected

Definition at line 14 of file SamplingBase.hpp.

Referenced by FlatTop::initDomainDecomp(), SamplingBase(), and FlatTop::setParameters().

◆ opalDist_m

std::shared_ptr<Distribution_t> SamplingBase::opalDist_m
protected

Definition at line 15 of file SamplingBase.hpp.

Referenced by FlatTop::countEnteringParticlesPerRank(), FlatTop::generateUniformDisk(), FlatTop::initDomainDecomp(), MultiVariateGaussian::MultiVariateGaussian(), SamplingBase(), and FlatTop::setParameters().

◆ pc_m

std::shared_ptr<ParticleContainer_t> SamplingBase::pc_m
protected

Definition at line 13 of file SamplingBase.hpp.

Referenced by FlatTop::allocateParticles(), FlatTop::countEnteringParticlesPerRank(), FlatTop::emitParticles(), FlatTop::generateParticles(), Gaussian::generateParticles(), MultiVariateGaussian::generateParticles(), FlatTop::generateUniformDisk(), FlatTop::initDomainDecomp(), SamplingBase(), SamplingBase(), and FlatTop::testNumEmitParticles().

◆ samplingMethod_m

std::string SamplingBase::samplingMethod_m
protected

Definition at line 16 of file SamplingBase.hpp.

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