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

#include <WignerVectorRealizer.h>

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

Collaboration diagram for QUESO::WignerVectorRealizer< 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 BaseEnvironment &	m_env

std::string	m_prefix

const VectorSet< V, M > &	m_unifiedImageSet

unsigned int	m_subPeriod

Detailed Description

template<class V, class M>
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 33 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, QUESO::BaseEnvironment::subDisplayFile(), UQ_FATAL_TEST_MACRO, and QUESO::BaseEnvironment::worldRank().

   :
   BaseVectorRealizer<V,M>(((std::string)(prefix)+"gen").c_str(),unifiedImageSet,std::numeric_limits<unsigned int>::max()),
   m_centerPos(new V(centerPos)),
   m_radius   (radius)    
 {
   if ((m_env.subDisplayFile()) && (m_env.displayVerbosity() >= 5)) {
     *m_env.subDisplayFile() << "Entering WignerVectorRealizer<V,M>::constructor()"
                             << ": prefix = " << m_prefix
                             << std::endl;
   }
 
   UQ_FATAL_TEST_MACRO(m_radius <= 0.,
                       m_env.worldRank(),
                       "WignerVectorRealizer<V,M>::constructor()",
                       "invalid radius");
 
   if ((m_env.subDisplayFile()) && (m_env.displayVerbosity() >= 5)) {
     *m_env.subDisplayFile() << "Leaving WignerVectorRealizer<V,M>::constructor()"
                             << ": prefix = " << m_prefix
                             << std::endl;
   }
 }

template<class V , class M >

QUESO::WignerVectorRealizer< V, M >::~WignerVectorRealizer ( )

Destructor.

Definition at line 62 of file WignerVectorRealizer.C.

 {
   delete m_centerPos;
 }

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 70 of file WignerVectorRealizer.C.

References UQ_FATAL_TEST_MACRO.

 {
   UQ_FATAL_TEST_MACRO(true,
                       m_env.worldRank(),
                       "WignerVectorRealizer<V,M>::realization()",
                       "not implemented yet");
   
   nextValues.cwSet(0.);
   return;
 }