BLTune Class Reference

#include <BLTune.hh>

List of all members.

---

Detailed Description

class BLTune contains the general interface to tuning arguments.

The tune command (class BLCMDtune) will tune arguments to commands with the goal of achieving some specified measure of performance. Tuning occurs when the Tune Particle is tracked, and only those aspects of performance that can be achieved during that tracking can be tuned. The example used here is to tune the current in a genericbend so the reference particle had dxdz=0 after the magnet.

Tunable arguments to a command must: a) be declared with argTunable() in defineArgs() b) be referenced indirectly by each placement class of the element; that is, the placement object cannot keep a local copy, but must always reference the actual parameter variable of the Element. c) be copied using BLTune::copyTunableArg() in the element's copy constructor

Tunable arguments are set on either the element or place command using the usual name=expression syntax. The expression can contain the name of any enclosing tune command as a variable, and the value of the variable will always be the current value during tuning, and will be the final result after tuning is complete.

Public Member Functions
	BLTune ()
	Constructor.
virtual	~BLTune ()
	Destructor.
Static Public Member Functions
static void	defineTunableArg (G4double &arg, G4double units, G4String expr)
	defineTunableArg() will define a tunable argument.
static void	copyTunableArg (G4double *newArg, const G4double *oldArg)
	copyTunableArg() will copy a tunable argument; for use in the copy constructor of Element classes.
static bool	isSet (G4String name)
	isSet() returns true if the varaible name is set.
static void	set (G4String &name, G4double value)
	set() will set the value of a tune variable, and update all arguments that use it.
static void	unset (G4String &name)
	unset() will remove a tune variable.
static void	update ()
	update() will update all tunable args with their current values.
Static Private Attributes
static BLEvaluator	eval
static std::map< G4double *, G4String >	tuneExpr
static std::map< G4double *, G4double >	tuneUnits

---

Constructor & Destructor Documentation

BLTune::BLTune

(

)

[inline]

Constructor.

{ }

virtual BLTune::~BLTune

(

)

[inline, virtual]

Destructor.

{ }

---

Member Function Documentation

void BLTune::defineTunableArg	(	G4double &	arg,
		G4double	units,
		G4String	expr
	)			[static]

defineTunableArg() will define a tunable argument.

References eval, BLEvaluator::evaluate(), BLCommand::printError(), tuneExpr, and tuneUnits.

Referenced by BLCommand::argTunable(), and copyTunableArg().

{
        tuneUnits[&arg] = units;
        tuneExpr[&arg] = expr;
        if(!eval.findFunction("sin",1)) eval.setStdMath();
        arg = eval.evaluate(expr) * units;
        if(eval.status() != HepTool::Evaluator::OK) {
                BLCommand::printError("Invalid expression '%s'",expr.c_str());
        }
}

void BLTune::copyTunableArg	(	G4double *	newArg,
		const G4double *	oldArg
	)			[static]

copyTunableArg() will copy a tunable argument; for use in the copy constructor of Element classes.

References defineTunableArg(), tuneExpr, and tuneUnits.

Referenced by BLCMDfieldexpr::BLCMDfieldexpr(), BLCMDfieldmap::BLCMDfieldmap(), BLCMDgenericbend::BLCMDgenericbend(), BLCMDidealsectorbend::BLCMDidealsectorbend(), BLCMDpillbox::BLCMDpillbox(), and BLCMDrfdevice::BLCMDrfdevice().

{
        if(tuneExpr.count((G4double*)oldArg) == 0)
                defineTunableArg(*newArg,1,"0");
        else
                defineTunableArg(*newArg,tuneUnits[(G4double*)oldArg],
                                                tuneExpr[(G4double*)oldArg]);
        *newArg = *oldArg;
}

bool BLTune::isSet

(

G4String

name

)

[static]

isSet() returns true if the varaible name is set.

References eval.

Referenced by BLCMDtune::command().

{
        return eval.findVariable(name);
}

void BLTune::set	(	G4String &	name,
		G4double	value
	)			[static]

set() will set the value of a tune variable, and update all arguments that use it.

References eval, and update().

Referenced by BLCMDtune::command(), and BLCMDtune::UserZSteppingAction().

{
        eval.setVariable(name,value);
        update();
}

void BLTune::unset

(

G4String &

name

)

[static]

unset() will remove a tune variable.

References eval.

{
        eval.removeVariable(name);
}

void BLTune::update

(

)

[static]

update() will update all tunable args with their current values.

References eval, BLEvaluator::evaluate(), BLCommand::printError(), tuneExpr, and tuneUnits.

Referenced by set().

{
        if(!eval.findFunction("sin",1)) eval.setStdMath();

        std::map<G4double*,G4String>::iterator i;
        for(i=tuneExpr.begin(); i!=tuneExpr.end(); ++i) {
                G4double *p = i->first;
                G4String expr = i->second;
                G4double units = tuneUnits[p];
                *p = eval.evaluate(expr) * units;
                if(eval.status() != HepTool::Evaluator::OK) {
                        BLCommand::printError("Invalid expression '%s'",
                                                        expr.c_str());
                }
        } 
}

---

Member Data Documentation

BLEvaluator BLTune::eval [static, private]

Referenced by defineTunableArg(), isSet(), set(), unset(), and update().

std::map< G4double *, G4String > BLTune::tuneExpr [static, private]

Referenced by copyTunableArg(), defineTunableArg(), and update().

std::map< G4double *, G4double > BLTune::tuneUnits [static, private]

Referenced by copyTunableArg(), defineTunableArg(), and update().

---

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

• BLTune.hh
• BLTune.cc