BLCMDsetdecay Class Reference

Inheritance diagram for BLCMDsetdecay:

List of all members.

---

Detailed Description

class BLCMDsetdecay -- implement the setdecay command

Public Member Functions
	BLCMDsetdecay ()
	Constructor.
	~BLCMDsetdecay ()
	Destructor.
G4String	commandName ()
	commandName() returns "setdecay"
int	command (BLArgumentVector &argv, BLArgumentMap &namedArgs)
	command() executes the command associated with this element.
void	defineNamedArgs ()
	defineNamedArgs() defines the named arguments for the command. Because arg names can be decay modes, this is handled in command().

---

Constructor & Destructor Documentation

BLCMDsetdecay::BLCMDsetdecay

(

)

Constructor.

References BLCMDTYPE_PHYSICS, BLCommand::registerCommand(), BLCommand::setDescription(), and BLCommand::setSynopsis().

                             : BLCommand()
{
        registerCommand(BLCMDTYPE_PHYSICS);
        setSynopsis("Set lifetime, decay channels, and branching ratios for a particle's decay.");
        setDescription("The particle is specified by name as the first "
                "positional argument.\n\n"
                "The lifetime of the particle can be set, unless it is "
                "a short-lived particle (for which lifetime is fixed at 0 -- "
                "these are particles like quarks, Zs, and Ws). "
                "Units are ns.\n\n"
                "Decay channels are specified 'daughter1,daughter2=BR', where "
                "the daughter names are separated by commas, and the branching "
                "ratio is a value between 0 and 1 (inclusive); the order of "
                "daughters does not matter. The sum of all BRs must be 1.0. "
                "It is best to use existing channels for the particle, because "
                "the code for the decay distribution is retained; new decay "
                "channels are given a default phase-space distribution, "
                "which is probably valid only for a 2-body decay of a spin 0 "
                "particle. New channels are limited to 4 daughters. "
                "Note that all desired decay channels must be listed.\n\n"
                "Example to force fast decay (0.1 ns) of pi+ to a positron:\n"
                "    setdecay pi+ lifetime=0.1 e+,nu_e=1.0"
                );
}

BLCMDsetdecay::~BLCMDsetdecay

(

)

[inline]

Destructor.

{ }

---

Member Function Documentation

G4String BLCMDsetdecay::commandName

(

)

[inline, virtual]

commandName() returns "setdecay"

Implements BLCommand.

{ return "setdecay"; }

int BLCMDsetdecay::command	(	BLArgumentVector &	argv,
		BLArgumentMap &	namedArgs
	)			[virtual]

command() executes the command associated with this element.

Implements BLCommand.

References SetDecayInstance::br, SetDecayInstance::channel, BLEvaluator::evaluate(), BLManager::getObject(), SetDecayInstance::lifetime, BLCommand::print(), BLCommand::printError(), and BLManager::registerCallback().

{
        int retval = 0;

        if(argv.size() < 1) {
                printError("setdecay: no decaying particle name.");
                retval = 1;
        }
        if(argv.size() > 1) {
                printError("setdecay: too many positional arguments.");
                retval = 1;
        }

        SetDecayInstance *instance = new SetDecayInstance(argv[0]);

        BLArgumentMap::iterator i;
        BLEvaluator eval;
        double totalBR=0.0;
        for(i=namedArgs.begin(); i!=namedArgs.end(); ++i) {
                G4String name = i->first;
                G4String value = i->second;
                if(name == "lifetime") {
                        instance->lifetime = eval.evaluate(value);
                        if(eval.status() != HepTool::Evaluator::OK)
                            printError("setdecay: invalid value for lifetime");
                        continue;
                }
                double v = eval.evaluate(value);
                if(eval.status() != HepTool::Evaluator::OK) {
                        printError("setdecay: invalid BR for %s",name.c_str());
                        continue;
                }
                instance->channel.push_back(name);
                instance->br.push_back(v);
                totalBR += v;
        }
        if(instance->channel.size() > 0 && fabs(totalBR-1.0) > 1.0e-6)
                printError("setdecay: branching ratios do not total to 1");

        print(argv[0],namedArgs);

        BLManager::getObject()->registerCallback(instance,0);

        return retval;
}

void BLCMDsetdecay::defineNamedArgs

(

)

[inline, virtual]

defineNamedArgs() defines the named arguments for the command. Because arg names can be decay modes, this is handled in command().

Reimplemented from BLCommand.

{ }

---

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

• BLCMDsetdecay.cc