queso-0.57.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Pages
QUESO::WignerVectorRealizer< V, M > Class Template Reference

A class for handling sampling from a Wigner probability density distribution. More...

#include <WignerVectorRealizer.h>

Inheritance diagram for QUESO::WignerVectorRealizer< V, M >:
QUESO::BaseVectorRealizer< V, M >

Public Member Functions

Constructor/Destructor methods
 WignerVectorRealizer (const char *prefix, const VectorSet< V, M > &unifiedImageSet, const V &centerPos, double radius)
 Constructor. More...
 
 ~WignerVectorRealizer ()
 Destructor. More...
 
Realization-related methods
void realization (V &nextValues) const
 TODO: Draws a realization. More...
 
- Public Member Functions inherited from QUESO::BaseVectorRealizer< V, M >
 BaseVectorRealizer (const char *prefix, const VectorSet< V, M > &unifiedImageSet, unsigned int subPeriod)
 Default constructor. More...
 
virtual ~BaseVectorRealizer ()
 Virtual destructor. More...
 
const VectorSet< V, M > & unifiedImageSet () const
 Image set where the realizations lie. Access to protected attribute m_unifiedImageSet. More...
 
unsigned int subPeriod () const
 Sub-period of the realization. Access to protected attribute m_subPeriod. More...
 

Private Attributes

V * m_centerPos
 
double m_radius
 

Additional Inherited Members

- Protected Attributes inherited from QUESO::BaseVectorRealizer< V, M >
const BaseEnvironmentm_env
 
std::string m_prefix
 
const VectorSet< V, M > & m_unifiedImageSet
 
unsigned int m_subPeriod
 

Detailed Description

template<class V = GslVector, class M = GslMatrix>
class QUESO::WignerVectorRealizer< V, M >

A class for handling sampling from a Wigner probability density distribution.

This class will handle sampling from an Wigner probability density distribution, with a given center position and a radius.

Todo:
: The method WignerVectorRealizer:realization() is not yet available, thus this class does nothing.

Definition at line 49 of file WignerVectorRealizer.h.

Constructor & Destructor Documentation

template<class V , class M >
QUESO::WignerVectorRealizer< V, M >::WignerVectorRealizer ( const char *  prefix,
const VectorSet< V, M > &  unifiedImageSet,
const V &  centerPos,
double  radius 
)

Constructor.

Constructs a new object, given a prefix, the image set of the vector realizer, the center position centerPos, and a radius radius.

Definition at line 34 of file WignerVectorRealizer.C.

References QUESO::BaseEnvironment::displayVerbosity(), QUESO::BaseVectorRealizer< V, M >::m_env, QUESO::BaseVectorRealizer< V, M >::m_prefix, QUESO::WignerVectorRealizer< V, M >::m_radius, and QUESO::BaseEnvironment::subDisplayFile().

39  :
40  BaseVectorRealizer<V,M>(((std::string)(prefix)+"gen").c_str(),unifiedImageSet,std::numeric_limits<unsigned int>::max()),
41  m_centerPos(new V(centerPos)),
42  m_radius (radius)
43 {
44  if ((m_env.subDisplayFile()) && (m_env.displayVerbosity() >= 5)) {
45  *m_env.subDisplayFile() << "Entering WignerVectorRealizer<V,M>::constructor()"
46  << ": prefix = " << m_prefix
47  << std::endl;
48  }
49 
50  queso_require_greater_msg(m_radius, 0., "invalid radius");
51 
52  if ((m_env.subDisplayFile()) && (m_env.displayVerbosity() >= 5)) {
53  *m_env.subDisplayFile() << "Leaving WignerVectorRealizer<V,M>::constructor()"
54  << ": prefix = " << m_prefix
55  << std::endl;
56  }
57 }
const BaseEnvironment & m_env
const VectorSet< V, M > & unifiedImageSet() const
Image set where the realizations lie. Access to protected attribute m_unifiedImageSet.
unsigned int displayVerbosity() const
Definition: Environment.C:450
std::ofstream * subDisplayFile() const
Access function for m_subDisplayFile (displays file on stream).
Definition: Environment.C:320
template<class V , class M >
QUESO::WignerVectorRealizer< V, M >::~WignerVectorRealizer ( )

Destructor.

Definition at line 60 of file WignerVectorRealizer.C.

61 {
62  delete m_centerPos;
63 }

Member Function Documentation

template<class V , class M >
void QUESO::WignerVectorRealizer< V, M >::realization ( V &  nextValues) const
virtual

TODO: Draws a realization.

Todo:
: implement and explain me!

Implements QUESO::BaseVectorRealizer< V, M >.

Definition at line 68 of file WignerVectorRealizer.C.

69 {
70  queso_not_implemented();
71 
72  nextValues.cwSet(0.);
73  return;
74 }

Member Data Documentation

template<class V = GslVector, class M = GslMatrix>
V* QUESO::WignerVectorRealizer< V, M >::m_centerPos
private

Definition at line 77 of file WignerVectorRealizer.h.

template<class V = GslVector, class M = GslMatrix>
double QUESO::WignerVectorRealizer< V, M >::m_radius
private

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

Generated on Tue Jun 5 2018 19:49:39 for queso-0.57.1 by  doxygen 1.8.5