BLCMDsolenoid Class Reference

Inheritance diagram for BLCMDsolenoid:

List of all members.

---

Detailed Description

BLCMDsolenoid implements a solenoid.

A solenoid consists of a BLCoil and a current value. It is a BLElement and can be placed geometrically (multiple times). The geometrical parameters are in the BLCoil, not the BLCMDsolenoid; this class uses the variables of its BLCoil to determine the geometry of the solenoid.

Public Member Functions
	BLCMDsolenoid ()
	Default constructor. Defines the command, etc.
virtual	~BLCMDsolenoid ()
	Destructor.
	BLCMDsolenoid (const BLCMDsolenoid &r)
	Copy constructor.
BLElement *	clone ()
	clone()
G4String	commandName ()
	commandName() returns "solenoid".
int	command (BLArgumentVector &argv, BLArgumentMap &namedArgs)
	command() implements the solenoid command.
void	defineNamedArgs ()
	defineNamedArgs() defines the named arguments of the command.
void	construct (G4RotationMatrix *relativeRotation, G4ThreeVector relativePosition, G4LogicalVolume *parent, G4String parentName, G4RotationMatrix *parentRotation, G4ThreeVector parentPosition)
	construct() - construct the solenoid. Creates a new SolenoidField and adds it to BLGlobalField.
G4double	getLength ()
	getLength() returns the length of the solenoid
G4double	getWidth ()
	getWidth() returns the outer radius of the solenoid
G4double	getHeight ()
	getHeight() returns the outer radius of the solenoid
G4bool	isOK ()
	isOK() returns true.
void	generatePoints (int npoints, std::vector< G4ThreeVector > &v)
	generatePoints() from BLElement
G4bool	isOutside (G4ThreeVector &local, G4double tolerance)
	isOutside() from BLElement
Private Attributes
G4String	coilName
G4double	current
G4String	color
G4int	alternate
G4int	kill
BLCoil *	coil
std::vector< SolenoidField * >	solenoidField
Friends
class	SolenoidField

---

Constructor & Destructor Documentation

BLCMDsolenoid::BLCMDsolenoid

(

)

Default constructor. Defines the command, etc.

References alternate, BLCMDTYPE_ELEMENT, coil, coilName, color, current, kill, BLCommand::registerCommand(), BLCommand::setDescription(), and BLCommand::setSynopsis().

Referenced by clone(), and command().

                             : BLElement(), solenoidField()
{
        // register the commandName(), and its synopsis and description.
        registerCommand(BLCMDTYPE_ELEMENT);
        setSynopsis("defines a solenoid (a coil and current)");
        setDescription("A solenoid is a coil and a current. If alternate is\n"
                "nonzero, then each placement of the solenoid (or an\n"
                "enclosing group) will flip the sign of current.");

        // provide initial values for fields
        coilName = "";
        current = 0.0;
        color = "1,1,1";
        alternate = 0;
        kill = 0;
        coil = 0;
}

virtual BLCMDsolenoid::~BLCMDsolenoid

(

)

[inline, virtual]

Destructor.

{ }

BLCMDsolenoid::BLCMDsolenoid

(

const BLCMDsolenoid &

r

)

Copy constructor.

References alternate, coil, coilName, color, current, and kill.

                                                   : BLElement(r), solenoidField()
{
        // copy fields one at a time (transfers default values from the
        // default object to this new object).
        coilName = r.coilName;
        current = r.current;
        color = r.color;
        alternate = r.alternate;
        kill = r.kill;
        coil = r.coil;
}

---

Member Function Documentation

BLElement* BLCMDsolenoid::clone

(

)

[inline, virtual]

clone()

Implements BLElement.

References BLCMDsolenoid().

{ return new BLCMDsolenoid(*this); }

G4String BLCMDsolenoid::commandName

(

)

[inline, virtual]

commandName() returns "solenoid".

Implements BLCommand.

{ return "solenoid"; }

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

command() implements the solenoid command.

Implements BLCommand.

References BLCMDsolenoid(), coil, coilName, BLCoil::find(), BLCommand::handleNamedArgs(), BLCommand::print(), BLCommand::printError(), and BLElement::setName().

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

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

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

        t->coil = BLCoil::find(t->coilName);
        if(t->coil == 0) {
                printError("solenoid: coil '%s' not found.",
                                                        t->coilName.c_str());
                retval = -1;
        }

        t->print(argv[0]);

        return retval;
}

void BLCMDsolenoid::defineNamedArgs

(

)

[virtual]

defineNamedArgs() defines the named arguments of the command.

Reimplemented from BLCommand.

References alternate, BLCommand::argDouble(), BLCommand::argInt(), BLCommand::argString(), coilName, color, current, and kill.

{
        argString(coilName,"coilName","The name of the coil (must exist)",false);
        // the map was generated for 1 Amp/mm^2, so this factor is actually unitless
        argDouble(current,"current","The current density in the conductor (Amp/mm^2)",1.0);
        argString(color,"color","The color of the solenoid (''=invisible).");
        argInt(alternate,"alternate","Set nonzero to alternate sign each placement.");
        argInt(kill,"kill","Set nonzero to kill all tracks that hit the coil.");
        argString(coilName,"coil","Synonym for coilName.",false);
}

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

construct() - construct the solenoid. Creates a new SolenoidField and adds it to BLGlobalField.

Implements BLElement.

References BLGlobalField::addElementField(), alternate, coil, color, current, BLCommand::getMaterial(), BLElement::getName(), BLManager::getObject(), BLGlobalField::getObject(), BLCoordinateTransform::getPosition(), BLCommand::getVisAttrib(), SolenoidField::global2local, BLCoil::innerRadius, kill, BLCoil::length, BLCoil::material, BLCoil::outerRadius, solenoidField, and SolenoidField.

{
        // geant4 rotation convention is backwards from g4beamline
        G4RotationMatrix *g4rot = 0;
        if(relativeRotation)
                g4rot = new G4RotationMatrix(relativeRotation->inverse());

        // 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;

        BLCoordinateTransform global2local(globalRotation,globalPosition);

        // add this solenoid to the GlobalField
        SolenoidField *sf = new SolenoidField(global2local,coil, current);
        BLGlobalField::getObject()->addElementField(sf);
        solenoidField.push_back(sf);

        if(alternate)
                current = -current;

        if(coil->length == 0.0)
                return;

        // construct the coil
        G4String thisname = parentName+getName();
        G4Tubs *tubs = new G4Tubs(thisname+"Tubs", coil->innerRadius, 
                        coil->outerRadius, coil->length/2.0, 0.0,2.0*pi);
        G4Material *mat = getMaterial(coil->material);
        G4LogicalVolume *lv = new G4LogicalVolume(tubs,mat, thisname+"LogVol");
        lv->SetVisAttributes(getVisAttrib(color));

        G4PVPlacement *pv = new G4PVPlacement(g4rot,relativePosition,lv,
                                        thisname, parent,false,0);

        if(kill)
                BLManager::getObject()->
                        registerSteppingAction(pv,new BLKillTrack(thisname));

        printf("BLCMDsolenoid::Construct %s parent=%s relZ=%.1f globZ=%.1f\n",
                thisname.c_str(),parentName.c_str(),relativePosition[2],
                global2local.getPosition()[2]);
        printf("\tglobal pos=%.1f,%.1f,%.1f  ",globalPosition[0],
                                globalPosition[1],globalPosition[2]);
}

G4double BLCMDsolenoid::getLength

(

)

[inline, virtual]

getLength() returns the length of the solenoid

Implements BLElement.

References coil, and BLCoil::length.

{ return coil->length; }

G4double BLCMDsolenoid::getWidth

(

)

[inline, virtual]

getWidth() returns the outer radius of the solenoid

Implements BLElement.

References coil, and BLCoil::outerRadius.

{ return coil->outerRadius*2.0; }

G4double BLCMDsolenoid::getHeight

(

)

[inline, virtual]

getHeight() returns the outer radius of the solenoid

Implements BLElement.

References coil, and BLCoil::outerRadius.

{ return coil->outerRadius*2.0; }

G4bool BLCMDsolenoid::isOK

(

)

[inline, virtual]

isOK() returns true.

Implements BLElement.

{ return true; }

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

generatePoints() from BLElement

Implements BLElement.

References coil, BLElement::generateTubs(), BLCoil::innerRadius, BLCoil::length, and BLCoil::outerRadius.

{
        v.clear();
        if(coil->length == 0) return;
        generateTubs(npoints, coil->innerRadius, coil->outerRadius, 0.0, 
                        360.0*deg, coil->length, v);
}

G4bool BLCMDsolenoid::isOutside	(	G4ThreeVector &	local,
		G4double	tolerance
	)			[virtual]

isOutside() from BLElement

Implements BLElement.

References coil, BLCoil::innerRadius, BLCoil::length, and BLCoil::outerRadius.

{
        if(coil->length == 0) return true;
        G4double r = sqrt(local[0]*local[0]+local[1]*local[1]);
        return r < coil->innerRadius+tolerance ||
                r > coil->outerRadius-tolerance ||
                fabs(local[2]) > coil->length/2.0-tolerance;
}

---

Friends And Related Function Documentation

friend class SolenoidField [friend]

Referenced by construct().

---

Member Data Documentation

G4String BLCMDsolenoid::coilName [private]

Referenced by BLCMDsolenoid(), command(), and defineNamedArgs().

G4double BLCMDsolenoid::current [private]

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

G4String BLCMDsolenoid::color [private]

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

G4int BLCMDsolenoid::alternate [private]

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

G4int BLCMDsolenoid::kill [private]

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

BLCoil* BLCMDsolenoid::coil [private]

Referenced by BLCMDsolenoid(), command(), construct(), generatePoints(), getHeight(), getLength(), getWidth(), and isOutside().

std::vector<SolenoidField *> BLCMDsolenoid::solenoidField [private]

Referenced by construct().

---

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

• BLCMDsolenoid.cc