Volume/Structure Builder Factories

Functions
AssemblyPtr	CreateAssembly (G4String name)
BoxBuilderPtr	CreateBoxBuilder (const G4String &name)
BoxBuilderPtr	CreateBoxBuilder (const G4String &name, G4double unit)
BoxBuilderPtr	CreateCenteredBoxBuilder (const G4String &name, G4double x_full_size, G4double y_full_size, G4double z_full_size)
BoxBuilderPtr	CreateCenteredBoxBuilder (G4double unit, const G4String &name, G4double x_full_size, G4double y_full_size, G4double z_full_size)
BoxBuilderPtr	CreateZDeltaBoxBuilder (const G4String &name, G4double x_full_size, G4double y_full_size, G4double edge_z, G4double z_delta)
BoxBuilderPtr	CreateZDeltaBoxBuilder (G4double unit, const G4String &name, G4double x_full_size, G4double y_full_size, G4double edge_z, G4double z_delta)
BoxBuilderPtr	CreateDeltasBoxBuilder (const G4String &name, G4double edge_x, G4double x_delta, G4double edge_y, G4double y_delta, G4double edge_z, G4double z_delta)
BoxBuilderPtr	CreateDeltasBoxBuilder (G4double unit, const G4String &name, G4double edge_x, G4double x_delta, G4double edge_y, G4double y_delta, G4double edge_z, G4double z_delta)
BoxBuilderPtr	CreateEdgesBoxBuilder (const G4String &name, G4double x_edge1, G4double x_edge2, G4double y_edge1, G4double y_edge2, G4double z_edge1, G4double z_edge2)
BoxBuilderPtr	CreateEdgesBoxBuilder (G4double unit, const G4String &name, G4double x_edge1, G4double x_edge2, G4double y_edge1, G4double y_edge2, G4double z_edge1, G4double z_edge2)
FromG4VSolidPtr	CreateFromG4VSolid (G4VSolid *solid)
RZBuilderPtr	CreatePolyhedraBuilder (const G4String &name, int sides, G4double phi_start=0., G4double phi_tot=360)
RZBuilderPtr	CreatePolyconeBuilder (const G4String &name, G4double phi_start=0., G4double phi_tot=360)
RZBuilderPtr	CreateCylinderBuilder (G4double unit, const G4String &name, G4double endz, G4double height, G4double OR, G4double IR=0)
RZBuilderPtr	CreateCylinderBuilder (const G4String &name, G4double endz, G4double height, G4double OR, G4double IR=0)

Detailed Description

Factories for creating VolumeBuilder and StructureBuilder objects.

/**

/**

Create an unconfigured Box Solid, for use with SetXEdges() etc... Uses the global default unit unless you call SetDefaultUnit() before setting sizes.

Parameters

name	Base name to derive geometry object names from.

Returns

The builder. Set configurations and then call .MakeSolid() and .MakeLogicalVolume() on it. See VolumeBuilder for inherited public methods including Union/Subtraction.

Factories for creating VolumeBuilder and StructureBuilder objects.

Function Documentation

CreateAssembly()

AssemblyPtr CreateAssembly

(

G4String

name

)

Assembly of strucures, ie builders and/or other assemblies.

Definition at line 25 of file Assembly.cc.

                                              {
        // Haha... assemblies actually are builders!!!
        auto object = AssemblyPtr(new Assembly());
        // ... with is_builder set to false.
        object->placement_configs_->is_builder = false;
        //We're storing a pointer to the view in the builder by writing to the builder through that same view!
        BuilderView builder_view = object->ToBuilderView();
        builder_view->StoreBuilderView(builder_view);
        // Then store itself in its new builder (that links to its data).
        //object->builder_configs_->builder_view->StoreIStructurePtr(IStructurePtr(object.get()));    // this is the owning copy.
        // ... and viewed through a reduced StructureView interface:
        object->SetName(name);
        auto return_obj = AssemblyPtr(object);
        return return_obj;
 
        // This let's us reuse builder methods!
    }

CreateBoxBuilder() [1/2]

BoxBuilderPtr CreateBoxBuilder

(

const G4String &

name

)

Definition at line 32 of file BoxBuilder.cc.

                                                         {
        auto object = BoxBuilderPtr(new BoxBuilder(name));
        return object;
    }

CreateBoxBuilder() [2/2]

BoxBuilderPtr CreateBoxBuilder	(	const G4String &	name,
		G4double	unit
	)

Create an unconfigured Box Solid, for use with SetXEdges() etc...

Parameters

name	Base name to derive geometry object names from.
unit	unit for this call only (ex: CLHEP::mm)

Returns

The builder. Set configurations and then call .MakeSolid() and .MakeLogicalVolume() on it. See VolumeBuilder for inherited public methods including Union/Subtraction.

Definition at line 37 of file BoxBuilder.cc.

                                                                              {
        auto object = BoxBuilderPtr(new BoxBuilder(name));
        object->SetDefaultUnit(unit);
        return object;
    }

CreateCenteredBoxBuilder() [1/2]

BoxBuilderPtr CreateCenteredBoxBuilder	(	const G4String &	name,
		G4double	x_full_size,
		G4double	y_full_size,
		G4double	z_full_size
	)

Create a Box solid.

Uses the global default unit

Parameters

name	Base name to derive geometry object names from.
x_full_size	FULL X size
y_full_size	FULL Y size
z_full_size	FULL Z size
name

Returns

The builder. Set configurations and then call .MakeSolid() and .MakeLogicalVolume() on it. See VolumeBuilder for inherited public methods including Union/Subtraction.

Definition at line 110 of file BoxBuilder.cc.

                                    {
        if (x_full_size <= 0 || y_full_size <= 0 || z_full_size <= 0) {
            throw std::invalid_argument("Error in CreateCenteredBoxBuilder(): for volume " + name
                                        + ": Sizes provided must be positive.\n");
        }
        auto object = BoxBuilderPtr(new BoxBuilder(name));
        object->SetXSize(x_full_size)
              ->SetYSize(y_full_size)
              ->SetZSize(z_full_size);
        return object;
    }

CreateCenteredBoxBuilder() [2/2]

BoxBuilderPtr CreateCenteredBoxBuilder	(	G4double	unit,
		const G4String &	name,
		G4double	x_full_size,
		G4double	y_full_size,
		G4double	z_full_size
	)

Create a Box solid.

Parameters

unit	The unit to use for this call only (ex: CLHEP::mm)
name	Base name to derive geometry object names from.
x_full_size	FULL X size
y_full_size	FULL Y size
z_full_size	FULL Z size

Returns

The builder. Set configurations and then call .MakeSolid() and .MakeLogicalVolume() on it. See VolumeBuilder for inherited public methods including Union/Subtraction.

Definition at line 96 of file BoxBuilder.cc.

                                    {
        if (x_full_size <= 0 || y_full_size <= 0 || z_full_size <= 0) {
            throw std::invalid_argument("Error in CreateCenteredBoxBuilder(): for volume " + name
                                        + ": Sizes provided must be positive.\n");
        }
        auto object = BoxBuilderPtr(new BoxBuilder(name));
        object->SetXSize(unit, x_full_size)
              ->SetYSize(unit, y_full_size)
              ->SetZSize(unit, z_full_size);
        return object;
    }

CreateCylinderBuilder() [1/2]

RZBuilderPtr CreateCylinderBuilder	(	const G4String &	name,
		G4double	endz,
		G4double	height,
		G4double	OR,
		G4double	IR = 0
	)

Create a simple cylinder builder using global default unit.

Parameters

name	Name used to derive all product names.
endz	The z reference of one end (either one)
height	Height, can be positive or negative (from z reference)
OR	Outer radius.
IR	Optional inner radius. Default=0

Returns

The builder. Set configurations and then call .MakeSolid() and .MakeLogicalVolume() on it. See VolumeBuilder for inherited public methods including Union/Subtraction.

Definition at line 60 of file RZBuilder.cc.

                     {
        return CreateCylinderBuilder(BuilderConfigs::global_default_unit, name, endz, h, OR, IR);
    }

CreateCylinderBuilder() [2/2]

RZBuilderPtr CreateCylinderBuilder	(	G4double	unit,
		const G4String &	name,
		G4double	endz,
		G4double	height,
		G4double	OR,
		G4double	IR = 0
	)

Create a simple cylinder builder.

Parameters

name	Name used to derive all product names.
unit	Unit applied to all values.
endz	The z reference of one end (either one)
height	Height, can be positive or negative (from z reference)
OR	Outer radius.
IR	Optional inner radius. Default=0

Returns

The builder. Set configurations and then call .MakeSolid() and .MakeLogicalVolume() on it. See VolumeBuilder for inherited public methods including Union/Subtraction.

Definition at line 44 of file RZBuilder.cc.

                                                                                                  {
        // ReSharper disable once CppDFAMemoryLeak
        auto object = RZBuilderPtr(new RZBuilder(name));
        object->MakeSolidFunctionPtr_ = &RZBuilder::MakePolycone;
        RZPlane plane;
        plane.unit = unit;
        plane.z = endz;
        plane.IR = IR;
        plane.OR = OR;
        object->AddPlane(plane);
        plane.z += h;
        object->AddPlane(plane);
        return RZBuilderPtr(object);
    }

CreateDeltasBoxBuilder() [1/2]

BoxBuilderPtr CreateDeltasBoxBuilder	(	const G4String &	name,
		G4double	edge_x,
		G4double	x_delta,
		G4double	edge_y,
		G4double	y_delta,
		G4double	edge_z,
		G4double	z_delta
	)

Create a Box solid.

Uses the global default unit

Parameters

name	Base name to derive geometry object names from.
edge_x	The x reference of one end (either one)
x_delta	FULL X size, + or - from end_x.
edge_y	The y reference of one end (either one)
y_delta	FULL Y size. + or - from end_y.
edge_z	The z reference of one end (either one)
z_delta	Height, can be positive or negative (from z reference)

Returns

The builder. Set configurations and then call .MakeSolid() and .MakeLogicalVolume() on it. See VolumeBuilder for inherited public methods including Union/Subtraction.

Definition at line 56 of file BoxBuilder.cc.

                                                                               {
        auto object = BoxBuilderPtr(new BoxBuilder(name));
        object->SetXEdgeDelta(edge_x, x_delta)
              ->SetYEdgeDelta(edge_y, y_delta)
              ->SetZEdgeDelta(edge_z, z_delta);
        return object;
    }

CreateDeltasBoxBuilder() [2/2]

BoxBuilderPtr CreateDeltasBoxBuilder	(	G4double	unit,
		const G4String &	name,
		G4double	edge_x,
		G4double	x_delta,
		G4double	edge_y,
		G4double	y_delta,
		G4double	edge_z,
		G4double	z_delta
	)

Create a Box solid.

Parameters

unit	The unit to use for this call only (ex: CLHEP::mm)
name	Base name to derive geometry object names from.
edge_x	The x reference of one end (either one)
x_delta	FULL X size, + or - from end_x.
edge_y	The y reference of one end (either one)
y_delta	FULL Y size. + or - from end_y.
edge_z	The z reference of one end (either one)
z_delta	Height, can be positive or negative (from z reference)

Returns

The builder. Set configurations and then call .MakeSolid() and .MakeLogicalVolume() on it. See VolumeBuilder for inherited public methods including Union/Subtraction.

Definition at line 44 of file BoxBuilder.cc.

                                {
        auto object = BoxBuilderPtr(new BoxBuilder(name));
        object->SetXEdgeDelta(unit, edge_x, x_delta)
              ->SetYEdgeDelta(unit, edge_y, y_delta)
              ->SetZEdgeDelta(unit, edge_z, z_delta);
        return object;
    }

CreateEdgesBoxBuilder() [1/2]

BoxBuilderPtr CreateEdgesBoxBuilder	(	const G4String &	name,
		G4double	x_edge1,
		G4double	x_edge2,
		G4double	y_edge1,
		G4double	y_edge2,
		G4double	z_edge1,
		G4double	z_edge2
	)

Create a Box solid from edge coordinates.

Uses the global default unit

Parameters

name	Base name to derive geometry object names from.
x_edge1	One end of the box in the x-dimension.
x_edge2	The other end of the box in the x-dimension.
y_edge1	One end of the box in the y-dimension.
y_edge2	The other end of the box in the y-dimension.
z_edge1	One end of the box in the z-dimension.
z_edge2	The other end of the box in the z-dimension.

Returns

The builder. Set configurations and then call .MakeSolid() and .MakeLogicalVolume() on it. See VolumeBuilder for inherited public methods including Union/Subtraction.

Definition at line 124 of file BoxBuilder.cc.

                                                                                {
        auto object = BoxBuilderPtr(new BoxBuilder(name));
        object->SetXEdges(x_edge1, x_edge2)
              ->SetYEdges(y_edge1, y_edge2)
              ->SetZEdges(z_edge1, z_edge2);
        return object;
    }

CreateEdgesBoxBuilder() [2/2]

BoxBuilderPtr CreateEdgesBoxBuilder	(	G4double	unit,
		const G4String &	name,
		G4double	x_edge1,
		G4double	x_edge2,
		G4double	y_edge1,
		G4double	y_edge2,
		G4double	z_edge1,
		G4double	z_edge2
	)

Create a Box solid from edge coordinates using a specified unit.

Parameters

unit	The unit to use for this call only (ex: CLHEP::mm)
name	Base name to derive geometry object names from.
x_edge1	One end of the box in the x-dimension.
x_edge2	The other end of the box in the x-dimension.
y_edge1	One end of the box in the y-dimension.
y_edge2	The other end of the box in the y-dimension.
z_edge1	One end of the box in the z-dimension.
z_edge2	The other end of the box in the z-dimension.

Returns

The builder. Set configurations and then call .MakeSolid() and .MakeLogicalVolume() on it. See VolumeBuilder for inherited public methods including Union/Subtraction.

Definition at line 134 of file BoxBuilder.cc.

                                {
        auto object = BoxBuilderPtr(new BoxBuilder(name));
        object->SetXEdges(unit, x_edge1, x_edge2)
              ->SetYEdges(unit, y_edge1, y_edge2)
              ->SetZEdges(unit, z_edge1, z_edge2);
        return object;
    }

CreateFromG4VSolid()

FromG4VSolidPtr CreateFromG4VSolid

(

G4VSolid *

solid

)

Constructor to make a builder from an Existing Geant solid.

Parameters

solid

G4VSolid pointer

Returns

Definition at line 25 of file FromG4VSolid.cc.

                                                        {
        auto object = FromG4VSolidPtr();
        object.get()->SetSolid(solid);
        object.get()->SetName(solid->GetName());
        return FromG4VSolidPtr(object);
    }

CreatePolyconeBuilder()

RZBuilderPtr CreatePolyconeBuilder	(	const G4String &	name,
		G4double	phi_start = 0.,
		G4double	phi_tot = 360
	)

Create a builder for associated IR,OR,Z defined object.

Parameters

name	Base name to derive geometry object names from.
phi_start	Optional Start angle
phi_tot	Optional Total degrees
sides	Optional number of sides, for CreatePoyhedra only, (can set it later, dflt = 4 )

Returns

The builder. Set configurations and then call .MakeSolid() and .MakeLogicalVolume() on it. See VolumeBuilder for inherited public methods including Union/Subtraction.

Definition at line 26 of file RZBuilder.cc.

                                                                                                   {
        // We could actually construct these as RZBuilderPtr without using new, vis i_shared_ptr constructor.
        // But maybe we can unfriend i_shared_ptr in the future if we use new here, and avoid exposing
        // a backdoor to the general ctor, which doesn't select a MakeSolidFunctionPtr.
        // ReSharper disable once CppDFAMemoryLeak
        auto object = RZBuilderPtr(new RZBuilder(name, phi_start, phi_tot, 0));
        object->MakeSolidFunctionPtr_ = &RZBuilder::MakePolycone;
        return RZBuilderPtr(object);
    }

CreatePolyhedraBuilder()

RZBuilderPtr CreatePolyhedraBuilder	(	const G4String &	name,
		int	sides,
		G4double	phi_start = 0.,
		G4double	phi_tot = 360
	)

Create a builder for associated IR,OR,Z defined object.

Parameters

name	Base name to derive geometry object names from.
phi_start	Optional Start angle
phi_tot	Optional Total degrees
sides	Optional number of sides, for CreatePoyhedra only, (can set it later, dflt = 4 )

Returns

The builder. Set configurations and then call .MakeSolid() and .MakeLogicalVolume() on it. See VolumeBuilder for inherited public methods including Union/Subtraction.

Definition at line 36 of file RZBuilder.cc.

                          {
        // ReSharper disable once CppDFAMemoryLeak
        auto object = new RZBuilder(name, phi_start, phi_tot, sides);
        object->MakeSolidFunctionPtr_ = &RZBuilder::MakePolyhedra;
        return RZBuilderPtr(object);
    }

CreateZDeltaBoxBuilder() [1/2]

BoxBuilderPtr CreateZDeltaBoxBuilder	(	const G4String &	name,
		G4double	x_full_size,
		G4double	y_full_size,
		G4double	edge_z,
		G4double	z_delta
	)

Create a Box solid.

Uses the global default unit.

Parameters

name	Base name to derive geometry object names from.
x_full_size	FULL X size
y_full_size	FULL Y size
edge_z	Full Z size
z_delta	Full Z size

Returns

The builder. Set configurations and then call .MakeSolid() and .MakeLogicalVolume() on it. See VolumeBuilder for inherited public methods including Union/Subtraction.

Definition at line 82 of file BoxBuilder.cc.

                                {
        if (x_full_size <= 0 || y_full_size <= 0) {
            throw std::invalid_argument("Error in CreateZDeltaBoxBuilder(): for volume " + name
                                        + ": Sizes provided without end offsets must be positive.\n");
        }
        auto object = BoxBuilderPtr(new BoxBuilder(name));
        object->SetXSize(x_full_size)
              ->SetYSize(y_full_size)
              ->SetZEdgeDelta(edge_z, z_delta);
        return object;
    }

CreateZDeltaBoxBuilder() [2/2]

BoxBuilderPtr CreateZDeltaBoxBuilder	(	G4double	unit,
		const G4String &	name,
		G4double	x_full_size,
		G4double	y_full_size,
		G4double	edge_z,
		G4double	z_delta
	)

Create a Box solid.

Parameters

unit	The unit to use for this call only (ex: CLHEP::mm)
name	Base name to derive geometry object names from.
x_full_size	FULL X size
y_full_size	FULL Y size
edge_z	Full Z size
z_delta	Full Z size

Returns

The builder. Set configurations and then call .MakeSolid() and .MakeLogicalVolume() on it. See VolumeBuilder for inherited public methods including Union/Subtraction.

Definition at line 67 of file BoxBuilder.cc.

                                                       {
        if (x_full_size <= 0 || y_full_size <= 0) {
            throw std::invalid_argument("Error in CreateZDeltaBoxBuilder(): for volume " + name
                                        + ": Sizes provided without end offsets must be positive.\n");
        }
        auto object = BoxBuilderPtr(new BoxBuilder(name));
        object->SetXSize(unit, x_full_size)
              ->SetYSize(unit, y_full_size)
              ->SetZEdgeDelta(unit, edge_z, z_delta);
        return object;
    }