SPH
Public Member Functions | List of all members
StratifiedDistribution Class Reference

Generates random positions using stratified sampling. More...

#include <Distribution.h>

Inheritance diagram for StratifiedDistribution:
IDistribution Polymorphic

Public Member Functions

 StratifiedDistribution (const Size seed)
 
virtual Array< Vectorgenerate (IScheduler &scheduler, const Size n, const IDomain &domain) const override
 Generates the requested number of particles in the domain. More...
 
- Public Member Functions inherited from Polymorphic
virtual ~Polymorphic ()
 

Detailed Description

Generates random positions using stratified sampling.

Definition at line 55 of file Distribution.h.

Constructor & Destructor Documentation

◆ StratifiedDistribution()

StratifiedDistribution::StratifiedDistribution ( const Size  seed)
explicit

Definition at line 63 of file Distribution.cpp.

Member Function Documentation

◆ generate()

Array< Vector > StratifiedDistribution::generate ( IScheduler scheduler,
const Size  n,
const IDomain domain 
) const
overridevirtual

Generates the requested number of particles in the domain.

Function shall also set the smoothing lenghts of the generated particles in the 4th components of the returned vectors.

Parameters
schedulerScheduler that can be used for parallelization.
nExpected number of generated particles.
domainComputational domain where the vertices are distributed
Returns
Output array of vertices. The total number of vertices can slightly differ from n.
Note
This method is expected to be called once at the beginning of the run, so we can return allocated array without worrying about performance costs here.

Implements IDistribution.

Definition at line 66 of file Distribution.cpp.


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