BLCMDfieldmap Class Reference

Inheritance diagram for BLCMDfieldmap:

List of all members.

---

Detailed Description

class BLCMDfieldmap implements a FieldMap command

This command has no volumes, logical or physical. it just implements a field (E and/or B) from an input file based on BLFieldMap.

Public Member Functions
	BLCMDfieldmap ()
	Default constructor. Defines the command, args, etc.
virtual	~BLCMDfieldmap ()
	Destructor.
	BLCMDfieldmap (const BLCMDfieldmap &r)
	Copy constructor.
BLElement *	clone ()
	clone()
G4String	commandName ()
	commandName() returns "fieldmap".
int	command (BLArgumentVector &argv, BLArgumentMap &namedArgs)
	command() implements the fieldmap command.
void	defineNamedArgs ()
	defineNamedArgs() defines the named arguments for the command.
void	construct (G4RotationMatrix *relativeRotation, G4ThreeVector relativePosition, G4LogicalVolume *parent, G4String parentName, G4RotationMatrix *parentRotation, G4ThreeVector parentPosition)
	construct() - construct the fieldmap
G4double	getLength ()
	getLength() returns 0 (no physical volume here)
G4double	getWidth ()
	getWidth() returns 0 (no physical volume nere)
G4double	getHeight ()
	getHeight() returns 0 (no physical volume nere)
G4bool	isOK ()
	isOK() returns true.
bool	isOutside (G4ThreeVector &local, G4double tolerance)
	isOutside() from BLElement. (no volume => every point is "outside")
void	generatePoints (int npoints, std::vector< G4ThreeVector > &v)
	generatePoints() from BLElement. (no volume => no generate)
Private Attributes
BLFieldMap *	map
G4String	filename
G4double	current
G4double	gradient
G4double	timeOffset

---

Constructor & Destructor Documentation

BLCMDfieldmap::BLCMDfieldmap

(

)

Default constructor. Defines the command, args, etc.

References BLCMDTYPE_ELEMENT, current, gradient, map, BLCommand::registerCommand(), BLCommand::setDescription(), BLCommand::setSynopsis(), and timeOffset.

Referenced by clone(), and command().

                             : BLElement()
{
        // register the commandName(), and its synopsis and description.
        registerCommand(BLCMDTYPE_ELEMENT);
        setSynopsis("implements a field map, E and/or B, from a file.");
        setDescription("Reads an input file in BLFieldMap format to define "
                "E and/or B fields, optionally with time dependence. "
                "See the Users Guide for a description of the BLFieldMap "
                "format."
                "");

        // provide initial values for fields
        map = 0;
        current = 1.0;
        gradient = 1.0;
        timeOffset = 0.0;
}

virtual BLCMDfieldmap::~BLCMDfieldmap

(

)

[inline, virtual]

Destructor.

{ }

BLCMDfieldmap::BLCMDfieldmap

(

const BLCMDfieldmap &

r

)

Copy constructor.

References BLTune::copyTunableArg(), current, gradient, map, and timeOffset.

                                                   : BLElement(r)
{
        // copy fields one at a time (transfers default values from the
        // default object to this new object).
        map = r.map;
        BLTune::copyTunableArg(&current,&r.current);
        BLTune::copyTunableArg(&gradient,&r.gradient);
        timeOffset = r.timeOffset;
}

---

Member Function Documentation

BLElement* BLCMDfieldmap::clone

(

)

[inline, virtual]

clone()

Implements BLElement.

References BLCMDfieldmap().

{ return new BLCMDfieldmap(*this); }

G4String BLCMDfieldmap::commandName

(

)

[inline, virtual]

commandName() returns "fieldmap".

Implements BLCommand.

{ return "fieldmap"; }

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

command() implements the fieldmap command.

Implements BLCommand.

References BLCMDfieldmap(), filename, BLCommand::handleNamedArgs(), map, BLCommand::print(), BLCommand::printError(), BLFieldMap::readFile(), and BLElement::setName().

{
        if(argv.size() != 1) {
                BLCommand::printError("fieldmap: Invalid command, must have name");
                return -1;
        }

        if(argv[0] == "default") {
                return defaultFieldMapCmd.handleNamedArgs(namedArgs);
        }

        BLCMDfieldmap *t = new BLCMDfieldmap(defaultFieldMapCmd);
        t->setName(argv[0]);
        int retval = t->handleNamedArgs(namedArgs);

        t->map = new BLFieldMap();
        t->map->readFile(t->filename);

        t->print(argv[0]);

        return retval;
}

void BLCMDfieldmap::defineNamedArgs

(

)

[virtual]

defineNamedArgs() defines the named arguments for the command.

Reimplemented from BLCommand.

References BLCommand::argDouble(), BLCommand::argString(), BLCommand::argTunable(), current, filename, gradient, and timeOffset.

{
        argString(filename,"filename","Filename for the Field Map.",false);
        argString(filename,"file","Synonym for filename.",false);
        argTunable(current,"current","Current of the B-field.");
        argTunable(gradient,"gradient","Gradient of the E-field.");
        argDouble(timeOffset,"timeOffset","Time offset (ns).");
}

void BLCMDfieldmap::construct	(	G4RotationMatrix *	relativeRotation,
		G4ThreeVector	relativePosition,
		G4LogicalVolume *	parent,
		G4String	parentName,
		G4RotationMatrix *	parentRotation,
		G4ThreeVector	parentPosition
	)			[virtual]

construct() - construct the fieldmap

Implements BLElement.

References BLGlobalField::addElementField(), current, BLElement::getName(), BLGlobalField::getObject(), gradient, map, and timeOffset.

{
        G4String thisname = parentName+getName();

        // get globalRotation and globalPosition
        G4RotationMatrix *globalRotation = 0;
        if(relativeRotation && parentRotation) {
                globalRotation = 
                    new G4RotationMatrix(*parentRotation * *relativeRotation);
        } else if(relativeRotation) {
                globalRotation = relativeRotation;
        } else if(parentRotation) {
                globalRotation = parentRotation;
        }
        G4ThreeVector globalPosition(relativePosition + parentPosition);
        if(parentRotation)
                globalPosition = *parentRotation * relativePosition +
                                parentPosition;

        FieldMapPlacement *p = new FieldMapPlacement(map,globalRotation,
                                globalPosition,current,gradient,timeOffset);
        BLGlobalField::getObject()->addElementField(p);

        printf("BLMappedMagnet::Construct %s parent=%s relZ=%.1f\n",
                thisname.c_str(),parentName.c_str(),relativePosition[2]);
}

G4double BLCMDfieldmap::getLength

(

)

[inline, virtual]

getLength() returns 0 (no physical volume here)

Implements BLElement.

{ return 0.0; }

G4double BLCMDfieldmap::getWidth

(

)

[inline, virtual]

getWidth() returns 0 (no physical volume nere)

Implements BLElement.

{ return 0.0; }

G4double BLCMDfieldmap::getHeight

(

)

[inline, virtual]

getHeight() returns 0 (no physical volume nere)

Implements BLElement.

{ return 0.0; }

G4bool BLCMDfieldmap::isOK

(

)

[inline, virtual]

isOK() returns true.

Implements BLElement.

{ return true; }

bool BLCMDfieldmap::isOutside	(	G4ThreeVector &	local,
		G4double	tolerance
	)			[inline, virtual]

isOutside() from BLElement. (no volume => every point is "outside")

Implements BLElement.

                { return true; }

void BLCMDfieldmap::generatePoints	(	int	npoints,
		std::vector< G4ThreeVector > &	v
	)			[inline, virtual]

generatePoints() from BLElement. (no volume => no generate)

Implements BLElement.

                { v.clear(); }

---

Member Data Documentation

BLFieldMap* BLCMDfieldmap::map [private]

Referenced by BLCMDfieldmap(), command(), and construct().

G4String BLCMDfieldmap::filename [private]

Referenced by command(), and defineNamedArgs().

G4double BLCMDfieldmap::current [private]

Referenced by BLCMDfieldmap(), construct(), and defineNamedArgs().

G4double BLCMDfieldmap::gradient [private]

Referenced by BLCMDfieldmap(), construct(), and defineNamedArgs().

G4double BLCMDfieldmap::timeOffset [private]

Referenced by BLCMDfieldmap(), construct(), and defineNamedArgs().

---

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

• BLCMDfieldmap.cc