www.mooseframework.org
Public Member Functions | Private Attributes | List of all members
Sampler::Location Struct Reference

Simple object for storing the sampler location (see SamplerMultiApp). More...

#include <Sampler.h>

Public Member Functions

 Location (const unsigned int &s, const unsigned int &r)
 
unsigned int sample () const
 Accessors for the sample and row numbers. More...
 
unsigned int row () const
 

Private Attributes

const unsigned int _sample
 Sample number (i.e., the index in the matrix) More...
 
const unsigned int _row
 Row number for the given sample matrix. More...
 

Detailed Description

Simple object for storing the sampler location (see SamplerMultiApp).

Parameters
sSample index (index associated with DenseMatrix returned by Sampler::getSamples())
rRow index (index associated with the row in the DenseMatrix defined by s).

Definition at line 56 of file Sampler.h.

Constructor & Destructor Documentation

Sampler::Location::Location ( const unsigned int &  s,
const unsigned int &  r 
)
inline

Definition at line 58 of file Sampler.h.

58 : _sample(s), _row(r) {}
const unsigned int _row
Row number for the given sample matrix.
Definition: Sampler.h:73
const unsigned int _sample
Sample number (i.e., the index in the matrix)
Definition: Sampler.h:70

Member Function Documentation

unsigned int Sampler::Location::row ( ) const
inline

Definition at line 65 of file Sampler.h.

65 { return _row; }
const unsigned int _row
Row number for the given sample matrix.
Definition: Sampler.h:73
unsigned int Sampler::Location::sample ( ) const
inline

Accessors for the sample and row numbers.

Definition at line 64 of file Sampler.h.

Referenced by Sampler::getSampleNames().

64 { return _sample; }
const unsigned int _sample
Sample number (i.e., the index in the matrix)
Definition: Sampler.h:70

Member Data Documentation

const unsigned int Sampler::Location::_row
private

Row number for the given sample matrix.

Definition at line 73 of file Sampler.h.

Referenced by row().

const unsigned int Sampler::Location::_sample
private

Sample number (i.e., the index in the matrix)

Definition at line 70 of file Sampler.h.

Referenced by sample().


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