BLCMDextrusion Class Reference

Inheritance diagram for BLCMDextrusion:

List of all members.

---

Detailed Description

BLCMDextrusion implements an extrusion of material, axis along Z.

Public Member Functions
	BLCMDextrusion ()
	Default constructor. Defines the command, args, etc.
virtual	~BLCMDextrusion ()
	Destructor.
	BLCMDextrusion (const BLCMDextrusion &r)
	Copy constructor.
BLElement *	clone ()
	clone()
G4String	commandName ()
	commandName() returns "extrusion".
int	command (BLArgumentVector &argv, BLArgumentMap &namedArgs)
	command() implements the extrusion command.
void	setup ()
	setup() will handle the vertices, and determine height and width.
void	defineNamedArgs ()
	defineNamedArgs() defines the named arguments for the command.
virtual void	construct (G4RotationMatrix *relativeRotation, G4ThreeVector relativePosition, G4LogicalVolume *parent, G4String parentName, G4RotationMatrix *parentRotation, G4ThreeVector parentPosition)
	construct() - construct the extrusion
G4double	getLength ()
	getLength() returns the length of the extrusion
G4double	getWidth ()
	getWidth() returns the width of the extrusion
G4double	getHeight ()
	getHeight() returns the height of the extrusion
G4bool	isOK ()
	isOK() returns true.
bool	isOutside (G4ThreeVector &local, G4double tolerance)
	isOutside() from BLElement.
void	generatePoints (int npoints, std::vector< G4ThreeVector > &v)
	generatePoints() from BLElement.
bool	isWithin (G4ThreeVector &local, G4double tolerance)
	isWithin() from BLGroupElement.
Private Attributes
G4double	length
G4String	vertices
G4double	scale1
G4double	scale2
G4String	material
G4String	color
G4int	kill
G4double	maxStep
G4ExtrudedSolid *	extrusion
std::vector< G4TwoVector >	polygon
G4double	height
G4double	width

---

Constructor & Destructor Documentation

BLCMDextrusion::BLCMDextrusion

(

)

Default constructor. Defines the command, args, etc.

References BLCMDTYPE_ELEMENT, color, extrusion, height, kill, length, material, maxStep, BLCommand::registerCommand(), scale1, scale2, BLCommand::setDescription(), BLCommand::setSynopsis(), vertices, and width.

Referenced by clone(), and command().

                               : BLGroupElement(), polygon()
{
        // register the commandName(), and its synopsis and description.
        registerCommand(BLCMDTYPE_ELEMENT);
        setSynopsis("construct a solid extrusion with axis along z");
        setDescription("This is a basic interface to G4ExtrudedSolid.\n"
                "A simple polygon in the X-Y plane is extruded along z, "
                "with optional scales in XY at the two ends (which generate "
                "a linear scaling along z).\n\n"
                "The polygon must be simple (no two sides intersect, no two "
                "vertices are equal). The vertices are listed starting from "
                "any vertex and traversing the polygon in either direction "
                "without lifting the pencil from the paper (Geant4 requires "
                "the traversal to be clockwise but this element internally "
                "reverses it if required). For an N-sided polygon give N "
                "vertices -- a side will be added from last to "
                "first to close the polygon; N is determined by "
                "counting the entries in the vertices argument.\n\n"
                "Note that while you cannot make an extrusion with a hole, you "
                "can make such an object in two parts or by placing a "
                "daughter volume in this one.\n\n"
                "Note the position placed is x=0,y=0,z=0, which is centered "
                "along z, but need not be near the center of the polygon in "
                "XY.\n\n"
                "With scale1!=scale2 this is not really an extrusion; by "
                "making one of them 0.001 or so, you can construct a sharp "
                "apex.\n\n"
                "Any x or y value in vertices can be an expression using "
                "double constants and the usual C operators and functions.");

        // provide initial values for fields
        length = 0.0;
        vertices = "";
        scale1 = 1.0;
        scale2 = 1.0;
        material = "";
        color = "1,1,1";
        kill = 0;
        maxStep = -1;
        extrusion = 0;
        height = 0.0;
        width = 0.0;
}

virtual BLCMDextrusion::~BLCMDextrusion

(

)

[inline, virtual]

Destructor.

{ }

BLCMDextrusion::BLCMDextrusion

(

const BLCMDextrusion &

r

)

Copy constructor.

References color, extrusion, height, kill, length, material, maxStep, scale1, scale2, vertices, and width.

                                                      : BLGroupElement(r),
                                                        polygon(r.polygon)
{
        length = r.length;
        vertices = r.vertices;
        scale1 = r.scale1;
        scale2 = r.scale2;
        material = r.material;
        color = r.color;
        kill = r.kill;
        maxStep = r.maxStep;
        extrusion = 0;
        height = r.height;
        width = r.width;
}

---

Member Function Documentation

BLElement* BLCMDextrusion::clone

(

)

[inline, virtual]

clone()

Implements BLElement.

References BLCMDextrusion().

{ return new BLCMDextrusion(*this); }

G4String BLCMDextrusion::commandName

(

)

[inline, virtual]

commandName() returns "extrusion".

Implements BLCommand.

{ return "extrusion"; }

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

command() implements the extrusion command.

Implements BLCommand.

References BLCMDextrusion(), BLParam::getDouble(), BLCommand::getMaterial(), BLCommand::handleNamedArgs(), material, maxStep, Param, BLCommand::print(), BLCommand::printError(), BLGroupElement::setName(), and setup().

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

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

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

        if(t->maxStep < 0.0) t->maxStep = Param.getDouble("maxStep");

        t->setup();

        // check material exists
        if(t->material.size() > 0) getMaterial(t->material,false);

        t->print(argv[0]);

        return retval;
}

void BLCMDextrusion::setup

(

)

setup() will handle the vertices, and determine height and width.

References BLCommand::getList(), height, polygon, BLCommand::printError(), scale1, scale2, BLCommand::splitString(), vertices, and width.

Referenced by command().

{
        width = 0.0;
        height = 0.0;

        // get vertices into polygon[]
        polygon.clear();
        std::vector<G4String> v=splitString(vertices,";",true);
        for(unsigned i=0; i<v.size(); ++i) {
                if(v[i].size() == 0) continue;
                std::vector<G4double> p=getList(v[i],",");
                if(p.size() != 2) {
                        printError("Syntax error in vertices");
                        polygon.clear();
                        break;
                }
                G4TwoVector point(p[0],p[1]);
                polygon.push_back(point);
                if(width < fabs(p[0])) width = fabs(p[0]);
                if(height < fabs(p[1])) height = fabs(p[1]);
        }
        if(polygon.size() < 3) {
                printError("extrusion: polygon has Fewer than three vertices");
                return;
        }

        // Compute the signed area to determine if it is traversed clockwise or 
        // ccw; invert the order if ccw because G4ExtrudedSolid requires cw.
        // (This is known as the "surveyor's formula".)
        double area=0.0;
        polygon.push_back(polygon[0]); // extra point for simplicity
        for(unsigned i=0; i<polygon.size()-1; ++i) {
                area += polygon[i].x()*polygon[i+1].y() -
                        polygon[i+1].x()*polygon[i].y(); // omit the 1/2
        }
        polygon.pop_back(); // remove extra point
        if(area > 0.0) {        // invert the order of the vertices
                std::vector<G4TwoVector> tmp;
                for(unsigned i=0; i<polygon.size(); ++i)
                        tmp.push_back(polygon[polygon.size()-1-i]);
                for(unsigned i=0; i<polygon.size(); ++i)
                        polygon[i] = tmp[i];
        }

        width *= 2 * (scale1>scale2 ? scale1 : scale2);
        height *= 2 * (scale1>scale2 ? scale1 : scale2);
        return;
}

void BLCMDextrusion::defineNamedArgs

(

)

[virtual]

defineNamedArgs() defines the named arguments for the command.

Reimplemented from BLCommand.

References BLCommand::argDouble(), BLCommand::argInt(), BLCommand::argString(), color, kill, length, material, maxStep, scale1, scale2, and vertices.

{
        argDouble(length,"length","Length of the extrusion (mm).",1.0,"",false);
        argString(vertices,"vertices","List of vertices of the XY polygon "
                "(mm): 'x0,y0;x1,y1;...'; a line from last to first "
                "is added. A 2 mm square is: "
                "'-1,-1;-1,1;1,1;1,-1'",false);
        argDouble(scale1,"scale1","The XY scale at the upstream (-z) end (1.0).",1.0,"",false);
        argDouble(scale2,"scale2","The XY scale at the downstream (+z) end (1.0).",1.0,"",false);
        argDouble(maxStep,"maxStep","The maximum stepsize in the element (mm)",mm);
        argString(material,"material","The material of the extrusion");
        argString(color,"color","The color of the extrusion (''=invisible)");
        argInt(kill,"kill","Set nonzero to kill every track that enters.");
        argString(vertices,"vertexes","Synonym for vertices.",false);
}

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

construct() - construct the extrusion

Implements BLElement.

References color, BLGroupElement::constructChildren(), extrusion, BLParam::getDouble(), getLength(), BLCommand::getMaterial(), BLElement::getName(), BLManager::getObject(), BLCommand::getVisAttrib(), kill, length, material, maxStep, Param, polygon, scale1, and scale2.

{
        G4String thisname = parentName+getName();

        if(!extrusion) {
                G4TwoVector offset(0.0,0.0);
                extrusion = new G4ExtrudedSolid(thisname+"Extrusion", 
                                polygon,length/2.0,offset,scale1,offset,scale2);
        }
        G4Material *mat=0;
        if(material.size() == 0) 
                mat = parent->GetMaterial();
        else
                mat = getMaterial(material);
        G4LogicalVolume *lv = new G4LogicalVolume(extrusion,mat, thisname+"LogVol");
        lv->SetVisAttributes(getVisAttrib(color));
        if(maxStep < 0.0) maxStep = Param.getDouble("maxStep");
        lv->SetUserLimits(new G4UserLimits(maxStep));

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

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

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

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

        constructChildren(lv,thisname,globalRotation,globalPosition);

        printf("BLCMDextrusion::Construct %s parent=%s relZ=%.1f globZ=%.1f\n"
                        "\tzmin=%.1f zmax=%.1f kill=%d\n",
                thisname.c_str(),parentName.c_str(),relativePosition[2],
                globalPosition[2],
                globalPosition[2]-getLength()/2.0,
                globalPosition[2]+getLength()/2.0,
                kill);
}

G4double BLCMDextrusion::getLength

(

)

[inline, virtual]

getLength() returns the length of the extrusion

Implements BLElement.

References length.

Referenced by construct().

{ return length; }

G4double BLCMDextrusion::getWidth

(

)

[inline, virtual]

getWidth() returns the width of the extrusion

Implements BLElement.

References width.

{ return width; }

G4double BLCMDextrusion::getHeight

(

)

[inline, virtual]

getHeight() returns the height of the extrusion

Implements BLElement.

References height.

{ return height; }

G4bool BLCMDextrusion::isOK

(

)

[inline, virtual]

isOK() returns true.

Implements BLElement.

{ return true; }

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

isOutside() from BLElement.

Implements BLElement.

References BLAssert, and extrusion.

                { BLAssert(extrusion!=0);  return extrusion->Inside(local) != kInside; }

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

generatePoints() from BLElement.

Implements BLElement.

References extrusion.

                { v.clear();
                  for(int n=0; n<npoints*5; ++n) {
                        G4ThreeVector p=extrusion->GetPointOnSurface();
                        if(extrusion->Inside(p) == kSurface)
                                v.push_back(p);
                  }
                }

bool BLCMDextrusion::isWithin	(	G4ThreeVector &	local,
		G4double	tolerance
	)			[inline, virtual]

isWithin() from BLGroupElement.

Implements BLGroupElement.

References BLAssert, and extrusion.

            { BLAssert(extrusion!=0);  return extrusion->Inside(local) != kOutside; }

---

Member Data Documentation

G4double BLCMDextrusion::length [private]

Referenced by BLCMDextrusion(), construct(), defineNamedArgs(), and getLength().

G4String BLCMDextrusion::vertices [private]

Referenced by BLCMDextrusion(), defineNamedArgs(), and setup().

G4double BLCMDextrusion::scale1 [private]

Referenced by BLCMDextrusion(), construct(), defineNamedArgs(), and setup().

G4double BLCMDextrusion::scale2 [private]

Referenced by BLCMDextrusion(), construct(), defineNamedArgs(), and setup().

G4String BLCMDextrusion::material [private]

Referenced by BLCMDextrusion(), command(), construct(), and defineNamedArgs().

G4String BLCMDextrusion::color [private]

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

G4int BLCMDextrusion::kill [private]

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

G4double BLCMDextrusion::maxStep [private]

Referenced by BLCMDextrusion(), command(), construct(), and defineNamedArgs().

G4ExtrudedSolid* BLCMDextrusion::extrusion [private]

Referenced by BLCMDextrusion(), construct(), generatePoints(), isOutside(), and isWithin().

std::vector<G4TwoVector> BLCMDextrusion::polygon [private]

Referenced by construct(), and setup().

G4double BLCMDextrusion::height [private]

Referenced by BLCMDextrusion(), getHeight(), and setup().

G4double BLCMDextrusion::width [private]

Referenced by BLCMDextrusion(), getWidth(), and setup().

---

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

• BLCMDextrusion.cc