G4FissionProductYieldDist.hh

Go to the documentation of this file.

//
// ********************************************************************
// * License and Disclaimer                                           *
// *                                                                  *
// * The  Geant4 software  is  copyright of the Copyright Holders  of *
// * the Geant4 Collaboration.  It is provided  under  the terms  and *
// * conditions of the Geant4 Software License,  included in the file *
// * LICENSE and available at  http://cern.ch/geant4/license .  These *
// * include a list of copyright holders.                             *
// *                                                                  *
// * Neither the authors of this software system, nor their employing *
// * institutes,nor the agencies providing financial support for this *
// * work  make  any representation or  warranty, express or implied, *
// * regarding  this  software system or assume any liability for its *
// * use.  Please see the license in the file  LICENSE  and URL above *
// * for the full disclaimer and the limitation of liability.         *
// *                                                                  *
// * This  code  implementation is the result of  the  scientific and *
// * technical work of the GEANT4 collaboration.                      *
// * By using,  copying,  modifying or  distributing the software (or *
// * any work based  on the software)  you  agree  to acknowledge its *
// * use  in  resulting  scientific  publications,  and indicate your *
// * acceptance of all terms of the Geant4 Software license.          *
// ********************************************************************
//
/*
 * File:   G4FissionProductYieldDist.hh
 * Author: B. Wendt (wendbryc@isu.edu)
 *
 * Created on May 11, 2011, 12:04 PM
 */

#ifndef G4FISSIONPRODUCTYIELDDIST_HH
#define G4FISSIONPRODUCTYIELDDIST_HH

#include "G4Ions.hh"
#include "G4IonTable.hh"
#include "G4NeutronHPNames.hh"
#include "globals.hh"
#include "G4DynamicParticle.hh"
#include "G4DynamicParticleVector.hh"
#include "G4ReactionProduct.hh"

#include "G4ENDFTapeRead.hh"
#include "G4ENDFYieldDataContainer.hh"
#include "G4FFGEnumerations.hh"
#include "G4FPYNubarValues.hh"
#include "G4FPYSamplingOps.hh"
#include "G4FPYTreeStructures.hh"

class G4FissionProductYieldDist
{
public:
// Constructor definition
    G4FissionProductYieldDist( G4int WhichIsotope,
                               G4FFGEnumerations::MetaState WhichMetaState,
                               G4FFGEnumerations::FissionCause WhichCause,
                               G4FFGEnumerations::YieldType WhichYieldType,
                               std::istringstream& dataStream);
    G4FissionProductYieldDist( G4int WhichIsotope,
                               G4FFGEnumerations::MetaState WhichMetaState,
                               G4FFGEnumerations::FissionCause WhichCause,
                               G4FFGEnumerations::YieldType WhichYieldType,
                               G4int Verbosity,
                               std::istringstream& dataStream);
private:
    void Initialize( std::istringstream& dataStream );

public:
// Functions
    G4DynamicParticleVector* G4GetFission( void );
    G4Ions* G4GetFissionProduct( void );
    void G4SetAlphaProduction( G4double WhatAlphaProduction );
    void G4SetEnergy( G4double WhatIncidentEnergy );
    void G4SetTernaryProbability( G4double TernaryProbability );
    void G4SetVerbosity( G4int WhatVerbosity );

protected:
// Variables
    // Class descriptor variables
        const G4int Isotope_;
        const G4FFGEnumerations::MetaState MetaState_;
        const G4FFGEnumerations::FissionCause Cause_;
        const G4FFGEnumerations::YieldType YieldType_;

    // Datafile variables
        G4ENDFTapeRead* ENDFData_;

    // Fission generation variables
        G4Ions* AlphaDefinition_;
        G4double AlphaProduction_;
        G4double TernaryProbability_;
        G4Ions* GammaDefinition_;
        G4double IncidentEnergy_;
        G4double MeanGammaEnergy_;
        G4Ions* NeutronDefinition_;
        G4double Nubar_;
        G4double NubarWidth_;
        G4int RemainingZ_;
        G4int RemainingA_;
        G4double RemainingEnergy_;
        G4int Verbosity_;

    // Pointers to the field of trees and relevant normalization data
        ProbabilityTree* Trees_;
        G4Ions* SmallestZ_;
        G4Ions* SmallestA_;
        G4Ions* LargestZ_;
        G4Ions* LargestA_;
        G4int YieldEnergyGroups_;
        G4double* YieldEnergies_;
        G4double* MaintainNormalizedData_;
        G4double* DataTotal_;
        G4int TreeCount_;
        G4int BranchCount_;

    // Pointers to runtime classes that G4FissionProductYieldDist needs to
    // function properly
        G4IonTable* IonTable_;
        G4NeutronHPNames* ElementNames_;
        G4FPYSamplingOps* RandomEngine_;

//Functions
    void CheckAlphaSanity( void );
    G4Ions* FindParticle( G4double RandomParticle );
    G4Ions* FindParticleExtrapolation( G4double RandomParticle,
                                       G4bool LowerEnergyGroupExists );
    G4Ions* FindParticleInterpolation( G4double RandomParticle,
                                       G4int LowerEnergyGroup );
    G4Ions* FindParticleBranchSearch( ProbabilityBranch* Branch,
                                      G4double RandomParticle,
                                      G4int EnergyGroup1,
                                      G4int EnergyGroup2 );
    virtual void GenerateAlphas( std::vector< G4ReactionProduct* >* Alphas );
    virtual void GenerateNeutrons( std::vector< G4ReactionProduct* >* Neutrons );
    virtual G4Ions* GetFissionProduct( void ) = 0;
    G4Ions* GetParticleDefinition( G4int Product,
                                   G4FFGEnumerations::MetaState MetaState );
    G4String MakeDirectoryName( void );
    G4String MakeFileName( G4int Isotope,
                           G4FFGEnumerations::MetaState MetaState );
    G4DynamicParticle* MakeG4DynamicParticle( G4ReactionProduct* );
    G4String MakeIsotopeName( G4int Isotope,
                              G4FFGEnumerations::MetaState MetaState );
    virtual void MakeTrees( void );
    virtual void ReadProbabilities( void );
    void Renormalize( ProbabilityBranch* Branch );
    void SampleAlphaEnergies( std::vector< G4ReactionProduct* >* Alphas );
    void SampleGammaEnergies( std::vector< G4ReactionProduct* >* Gammas );
    void SampleNeutronEnergies( std::vector< G4ReactionProduct* >* Neutrons );
    void SetNubar( void );
    virtual void SortProbability( G4ENDFYieldDataContainer* YieldData );

// Destructor function(s)
public:
    virtual ~G4FissionProductYieldDist( void );
protected:
    void BurnTree( ProbabilityBranch* Branch );
};

#endif  /* G4FISSIONPRODUCTYIELDDIST_HH */