YAP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Protected Member Functions | Friends | List of all members
UnitSpinAmplitude Class Reference

Implements a spin amplitude that always returns Complex_1. More...

#include <UnitSpinAmplitude.h>

Inheritance diagram for UnitSpinAmplitude:
SpinAmplitude StaticDataAccessor DataAccessor

Public Member Functions

const std::complex< double > calc (int two_M, const SpinProjectionVector &two_m, const DataPoint &d, const std::shared_ptr< ParticleCombination > &pc) const override
 
virtual const std::complex
< double > 
amplitude (const DataPoint &d, const std::shared_ptr< ParticleCombination > &pc, int two_M, const SpinProjectionVector &two_m) const override
 
virtual std::string formalism () const override
 
- Public Member Functions inherited from SpinAmplitude
virtual operator std::string () const
 cast into string
 
virtual void calculate (DataPoint &d, StatusManager &sm) const override
 
bool equalTo (const SpinAmplitude &other) const
 check equivalence: only check spins and angular momenta
 
virtual bool equals (const SpinAmplitude &other) const
 check equality: calls equalTo and checks symmetrizationIndices
 
const unsigned initialTwoJ () const
 
const SpinVector & finalTwoJ () const
 
const unsigned L () const
 
const unsigned twoS () const
 
const std::set< int > twoM () const
 
const std::set
< SpinProjectionVector > 
twoM (int two_M) const
 
- Public Member Functions inherited from StaticDataAccessor
 StaticDataAccessor (Model &m, const ParticleCombinationEqualTo &equal)
 
const Modelmodel () const override
 
- Public Member Functions inherited from DataAccessor
 DataAccessor (const ParticleCombinationEqualTo &equal)
 
const ParticleCombinationEqualTo & equal () const
 
int index () const
 
unsigned symmetrizationIndex (const std::shared_ptr< ParticleCombination > &c) const
 
const ParticleCombinationMap
< unsigned > & 
symmetrizationIndices () const
 
const unsigned nSymmetrizationIndices () const
 
void printParticleCombinations () const
 print ParticleCombination map
 
const CachedValueSet & CachedValues () const
 
const unsigned size () const
 
const bool requiresStorage () const
 
bool consistent () const
 Check consistency of object.
 

Protected Member Functions

 UnitSpinAmplitude (Model &m, unsigned two_J, const SpinVector &two_j, unsigned l, unsigned two_s)
 
- Protected Member Functions inherited from SpinAmplitude
 SpinAmplitude (Model &m, unsigned two_J, const SpinVector &two_j, unsigned l, unsigned two_s, const ParticleCombinationEqualTo &equal)
 
void addAmplitude (int two_M, const SpinProjectionVector &two_m, bool store_null=false)
 
- Protected Member Functions inherited from StaticDataAccessor
virtual void registerWithModel () override
 register with Model
 
virtual void addToStaticDataAccessors ()
 add to model's StaticDataAccessors_
 
StaticDataAccessorVector & staticDataAccessors ()
 access to the model's StaticDataAccessors_
 
- Protected Member Functions inherited from DataAccessor
void addCachedValue (std::shared_ptr< CachedValue > c)
 add CachedValue
 
virtual void addParticleCombination (std::shared_ptr< ParticleCombination > pc)
 add ParticleCombination to SymmetrizationIndices_
 
virtual void pruneSymmetrizationIndices ()
 prune SymmetrizationIndices_ to only contain ParticleCombination's tracing back up the ISP
 
void setIndex (size_t i)
 set storage index used in DataPoint. Must be unique.
 

Friends

class SpinAmplitudeCache
 grant SpinAmplitudeCache friend status to call constructor
 

Additional Inherited Members

- Public Types inherited from SpinAmplitude
using AmplitudeSubmap = std::map< SpinProjectionVector, std::shared_ptr< ComplexCachedValue > >
 maps SpinProjectionVector to ComplexCachedValue
 
using AmplitudeMap = std::map< int, AmplitudeSubmap >
 maps parent spin projectin to AmplitudeSubmap
 
- Public Attributes inherited from DataAccessor
friend Model
 grant friend status to Model to access CachedValues_
 
friend CachedValue
 grant friend status to CachedValue to call addCachedValue
 

Detailed Description

Implements a spin amplitude that always returns Complex_1.

Author
Daniel Greenwald
Todo:
Remove actual caching

Constructor & Destructor Documentation

UnitSpinAmplitude ( Model m,
unsigned  two_J,
const SpinVector &  two_j,
unsigned  l,
unsigned  two_s 
)
inlineprotected

Constructor

Parameters
two_Jtwice the spin of initial state
two_jSpinVector of daughters
lorbital angular momentum
two_stwice the total spin angular momentum

Member Function Documentation

virtual const std::complex<double> amplitude ( const DataPoint d,
const std::shared_ptr< ParticleCombination > &  pc,
int  two_M,
const SpinProjectionVector &  two_m 
) const
inlineoverridevirtual
Returns
unit amplitude
Parameters
ddummy DataPoint
pcdummy ParticleCombination
two_M2 * spin projection of parent
two_mSpinProjectionVector of daughters

Reimplemented from SpinAmplitude.

const std::complex<double> calc ( int  two_M,
const SpinProjectionVector &  two_m,
const DataPoint d,
const std::shared_ptr< ParticleCombination > &  pc 
) const
inlineoverridevirtual
Returns
Complex_1 regardless of input

Implements SpinAmplitude.

virtual std::string formalism ( ) const
inlineoverridevirtual
Returns
"unit-valued"

Implements SpinAmplitude.


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