RZbuilder Configurations

Functions
virtual RZBuilderPtr	SetNumSides (G4double N)
RZBuilderPtr	AddPlane (const RZPlane &plane)
RZBuilderPtr	AddPlane (G4double IR, G4double OR, G4double z)
RZBuilderPtr	AddPlane (G4double unit, G4double IR, G4double OR, G4double z)
RZBuilderPtr	AddPlanes (const std::vector< RZPlane > &planes)
RZBuilderPtr	AddPlanes (const std::vector< RZPlaneUnitless > &planes)
RZBuilderPtr	AddPlanes (G4double unit, const std::vector< RZPlaneUnitless > &planes)
RZBuilderPtr	ReflectZSolidConfig ()
RZBuilderPtr	FillSolidConfig ()

Detailed Description

Solid Configurations for RZBuiler.

Function Documentation

AddPlane() [1/3]

RZBuilderPtr AddPlane

(

const RZPlane &

plane

)

Adds a plane defining one IR,OR,Z triplet in the volume design.

Parameters

plane

// the unit, IR, OR, Z data for this "plane"

Definition at line 134 of file RZBuilder.cc.

                                                         {
        if (plane.IR < 0 || plane.OR < 0) {
            throw std::runtime_error("Error in RZBuilder::AddPlane()"
                                     " for builder " + GetBuilderName() + ".\n"
                                     "IR and OR must be non-negative.");
        }
        IR_.push_back(plane.IR * plane.unit);
        OR_.push_back(plane.OR * plane.unit);
        z_.push_back(plane.z * plane.unit);
        num_planes_++;
        return shared_from_this();
    }

AddPlane() [2/3]

RZBuilderPtr AddPlane	(	G4double	IR,
		G4double	OR,
		G4double	z
	)

Adds a plane defining one IR,OR,Z triplet in the volume design Uses preset unit from default (mm) or SetUnit(unit);.

Parameters

IR	Inner radius
OR	Outer radius
z	Z position

Definition at line 153 of file RZBuilder.cc.

                                                                         {
        auto plane = RZPlane{GetEffectiveDefaultUnit(), IR, OR, z};
        return AddPlane(plane);
    }

AddPlane() [3/3]

RZBuilderPtr AddPlane	(	G4double	unit,
		G4double	IR,
		G4double	OR,
		G4double	z
	)

Adds a plane defining one IR,OR,Z triplet in the volume design Uses preset unit from default (mm) or SetUnit(unit);.

Parameters

unit	The unit to use for THIS plane only (ex: CLHEP::mm)
IR	Inner radius
OR	Outer radius
z	Z position

Definition at line 147 of file RZBuilder.cc.

                                                                                        {
        auto plane = RZPlane{unit, IR, OR, z};
        return AddPlane(plane);
    }

AddPlanes() [1/3]

RZBuilderPtr AddPlanes

(

const std::vector< RZPlane > &

planes

)

Adds multiple RZ planes each defining one unit,IR,OR,Z set in the volume design.

Parameters

planes

{{unit,IR, OR, Z},{unit,IR,OR,Z},...}, unit ex: CLHEP::mm

Definition at line 160 of file RZBuilder.cc.

                                                                      {
        for (const auto &plane : planes) {
            AddPlane(plane);
        }
        return shared_from_this();
    }

AddPlanes() [2/3]

RZBuilderPtr AddPlanes

(

const std::vector< RZPlaneUnitless > &

planes

)

Adds multiple planes each defining one IR,OR,Z triplet in the volume design Uses preset unit from default (mm) or SetUnit(unit);.

Parameters

planes

{{IR, OR, Z},{IR,OR,Z},...}

Definition at line 168 of file RZBuilder.cc.

                                                                              {
        for (const auto &plane : planes) {
            G4double unit = this->GetEffectiveDefaultUnit();
            auto rzplane = RZPlane{unit, plane.IR, plane.OR, plane.z};
            AddPlane(rzplane);
        }
        return shared_from_this();
    }

AddPlanes() [3/3]

RZBuilderPtr AddPlanes	(	G4double	unit,
		const std::vector< RZPlaneUnitless > &	planes
	)

Adds multiple planes each defining one IR,OR,Z triplet in the volume design Uses preset unit from default (mm) or SetUnit(unit);.

Parameters

unit	The unit to use for THESE planes only (ex: CLHEP::mm)
planes	{{IR, OR, Z},{IR,OR,Z},...}

Definition at line 178 of file RZBuilder.cc.

                                                                                             {
        for (const auto &plane : planes) {
            auto rzplane = RZPlane{unit, plane.IR, plane.OR, plane.z};
            AddPlane(rzplane);
        }
        return shared_from_this();
    }

FillSolidConfig()

RZBuilderPtr FillSolidConfig

(

)

Modifies a Solid CONFIGURATION to set all inner diameters (IDs) to 0.

This does NOT copy the solid and does preserve the name.

Let's say you have a hollow cylinder, but you want a mother volume to put it in.

auto cryostat_bot = cryostat_vac_bot->ForkAndReset("cryostat_vac_bot")
                                ->FillSolidConfig()
                                ->SetMaterial(_vacuum);
cryostat_bot->SetMother(cryostat_vac_bot);

Done.

See also

ReflectZSolidConfig() for a detailed example of a similar method.

Definition at line 91 of file RZBuilder.cc.

                                            {
        if (solid_ptr_) {
            throw std::runtime_error("Error in RZBuilder::FillSolidConfig\"\n"
                "Cannot fill a solid builder CONFIGURATION, when the solid is already built from it."
                "Use ForkAndReset(\"new_name\") first to get an unbuilt copy.\n\n");
        }
 
        // set all ID's to 0.
        for (int i = 0; i < num_planes_; i++) {
            this->IR_[i] = 0;
        }
        return this->shared_from_this();
    }

ReflectZSolidConfig()

RZBuilderPtr ReflectZSolidConfig

(

)

Flip Solid Configuration.

For use on builders with UNBUILT solids ONLY, preserving the name.
Useful for conditional configuration. Ex:

BuilderRefList builders;;  // array of builders to store intermediates or result.
for (int i=0; i<10; i++) {
    auto builder = CreateCylinderBuilder("x"+std::to_string(i) // SET INDEXED NAME
                                          ,0,10,20,0)          // use global units
               ->SetMaterial("G4_AIR")->SetMother(other_solid)
               ->SetPhysOffset(i*5,0,0);  // position for an array of cylinders.
    if (i>4) {
        builder->ReflectZSolidConfig(); // half of them are upside down. NO NAME CHANGE.
    }
    // make and optionally store the physical volumes
    builders.emplace_back(builder->MakePlacement());
 
}

If you use ReflectZCopy(newname) in the loop you'd need to provide a copy name, making your final solid naming harder (still possible) to set up right. You can skin this cat multiple other ways, but this provides options.

Returns

The same builder (allows chaining)

Definition at line 106 of file RZBuilder.cc.

                                                {
        if (solid_ptr_) {
            throw std::runtime_error("Error in RZBuilder::ReflectZSolidConfig\"\n"
                "Cannot flip a solid builder CONFIGURATION, when the solid is already built from it.\n"
                "Use ReflectZFinalSolidCopy(\"new_name\")  instead to copy and flip the solid.\n\n");
        }
        // Mirror z values
        for (int i = 0; i < num_planes_; i++) {
            this->z_[i] = -this->z_[i];
        }
        return this->shared_from_this();
    }

SetNumSides()

RZBuilderPtr SetNumSides ( G4double  N )

virtual

Set number of sides.

Only relevant for things with sides.

Parameters

N	Number of Sides

Definition at line 119 of file RZBuilder.cc.

                                                  {
        if (MakeSolidFunctionPtr_ == &RZBuilder::MakePolyhedra) {
            sides_ = n;
        } else {
            G4cout <<
                "Warning in RZBuilder: Calling SetNumSides() on a builder that makes round things"
                << " might be as clever as giving a balloon to a hedgehog. \n Ignoring call." <<
                G4endl;
        }
        return shared_from_this();
    }