PlacementConfigs

Functions
DerivedPtr	PlaceAndFork ()
DerivedPtr	SetPhysRotation (const G4RotationMatrix &rot)
DerivedPtr	SetPhysOffset (const DLG4::VolumeBuilders::ThreeVecDimensioner &offset={0, 0, 0, VB::Length::mm})
DerivedPtr	SetPhysTransform (const UnitlessG4Transform3D &new_transform)
G4Transform3D	GetPhysTransform () const
DerivedPtr	OverridePlacementName (const G4String &pName)
DerivedPtr	SetCopyNo (G4int pCopyNo)
DerivedPtr	SetSurfaceCheck (G4bool pSurfChk)
DerivedPtr	SetMother (const VolumeBuilder &mother)
DerivedPtr	SetAutoPlacementNaming (bool set)
DerivedPtr	SetAutoCopyNo (bool set)
DerivedPtr	PlaceAndFork ()
DerivedPtr	SetLogicalVolume (G4LogicalVolume *logical_volume)
DerivedPtr	SetBooleanName (const G4String &name)
DerivedPtr	SetPhysRotation (const G4RotationMatrix &rot)
DerivedPtr	SetPhysOffset (const DLG4::VolumeBuilders::ThreeVecDimensioner &offset={0, 0, 0, VB::Length::mm})
DerivedPtr	SetPhysTransform (const UnitlessG4Transform3D &new_transform)
G4Transform3D	GetPhysTransform () const final
DerivedPtr	OverridePlacementName (const G4String &pName)
DerivedPtr	SetCopyNo (G4int pCopyNo)
DerivedPtr	SetSurfaceCheck (G4bool pSurfChk)
DerivedPtr	SetMother (const VolumeBuilder &mother)
DerivedPtr	SetAutoPlacementNaming (bool set)
DerivedPtr	SetAutoCopyNo (bool set)

Detailed Description

Placement Configuration Setters These all return the builder for fluent interface.

Function Documentation

GetPhysTransform() [1/2]

template<typename U >

G4Transform3D GetPhysTransform ( ) const

inline

A helper to get the Physical Volume transform with units applied This is built from rotation and translatin if they were provided, or from a transform if it was provided, with units applied as specified.

Basically allows you to get the unit-multiplied version for use in direct Geant calls.

Returns

The Physical volume G4Transform3D with units applied.

Definition at line 294 of file StructureBuilderBase.hh.

                                                             {
            return {placement_configs_->rotation, placement_configs_->translation};
        }

GetPhysTransform() [2/2]

template<typename U >

G4Transform3D GetPhysTransform ( ) const

inlinefinalvirtual

A helper to get the Physical Volume transform with units applied This is built from rotation and translatin if they were provided, or from a transform if it was provided, with units applied as specified.

Basically allows you to get the unit-multiplied version for use in direct Geant calls.

Returns

The Physical volume G4Transform3D with units applied.

Implements IVolumeBuilder.

Definition at line 387 of file VolumeBuilderBase.hh.

                                                     {
            return {placement_configs_->rotation, placement_configs_->translation};
        }

OverridePlacementName() [1/2]

template<typename U >

DerivedPtr OverridePlacementName

(

const G4String &

pName

)

Set the placement name for the volume.

Parameters

pName

Name for the placement.

Returns

This builder for chaining.

OverridePlacementName() [2/2]

template<typename U >

VolumeBuilderBase< U >::DerivedPtr OverridePlacementName

(

const G4String &

pName

)

Set the placement name for the volume.

Parameters

pName

Name for the placement.

Returns

This builder for chaining.

Definition at line 619 of file VolumeBuilderBase.hpp.

                                                             {
        explicit_physical_copy_name_set_ = static_cast<bool>(pName);
        this->placement_name_override_ = pName;
        return this->shared_from_this();
    }

PlaceAndFork() [1/2]

template<typename U >

DerivedPtr PlaceAndFork

(

)

An alias for MakePlacement and ClonePlacement Used for one or many unaltered placments in sequence, usually with auto naming and/or numbering.

Returns

The builder

PlaceAndFork() [2/2]

template<typename U >

DerivedPtr PlaceAndFork ( )

inline

An alias for MakePlacement and ForkForPlacement Used for one or many unaltered placments in sequence, usually with auto naming and/or numbering.

Returns

The builder

Definition at line 112 of file VolumeBuilderBase.hh.

                                  {
            this->MakePlacement();
            auto clone = this->ForkForPlacement(); // default/preset options
            return clone;
        }

SetAutoCopyNo() [1/2]

template<typename U >

DerivedPtr SetAutoCopyNo

(

bool

set

)

Enable (disable for false) auto Physical Volume numbering, on by default.

Adds a copy number to every name. By default copy numbers auto increment. Or you can set explicit names and numbers in ClonePlacement.

Parameters

set	True before setting.

Returns

SetAutoCopyNo() [2/2]

template<typename U >

VolumeBuilderBase< U >::DerivedPtr SetAutoCopyNo

(

bool

set

)

Enable (disable for false) auto Physical Volume numbering, on by default.

Adds a copy number to every name. By default copy numbers auto increment. Or you can set explicit names and numbers in ClonePlacement.

Parameters

set	True before setting.

Returns

Definition at line 733 of file VolumeBuilderBase.hpp.

                                              {
        placement_configs_->auto_copyno = set;
        if (set) {
            placement_configs_->auto_copy_name = false;
        }
        return this->shared_from_this();
    }

SetAutoPlacementNaming() [1/2]

template<typename U >

DerivedPtr SetAutoPlacementNaming

(

bool

set

)

Enable auto Physical Volume naming.

Adds a copy number to every name. By default copy numbers auto increment.
This will turn that off. Both makes no sense.
Or you can set explicit names and numbers in ClonePlacement.

Parameters

set	False before setting.

Returns

SetAutoPlacementNaming() [2/2]

template<typename U >

VolumeBuilderBase< U >::DerivedPtr SetAutoPlacementNaming

(

bool

set

)

Enable auto Physical Volume naming.

Adds a copy number to every name. By default copy numbers auto increment.
This will turn that off. Both makes no sense.
Or you can set explicit names and numbers in ClonePlacement.

Parameters

set	False before setting.

Returns

Definition at line 724 of file VolumeBuilderBase.hpp.

                                                       {
        placement_configs_->auto_copy_name = set;
        if (set) {
            placement_configs_->auto_copyno = false;
        }
        return this->shared_from_this();
    }

SetBooleanName()

template<typename U >

VolumeBuilderBase< U >::DerivedPtr SetBooleanName

(

const G4String &

name

)

Pre-set base name for logical and physical volumes.

_L and _P will be appended, respectively.

If not set, the builder will take it from the builder name. But this is useful for unions where the starting solid name may be more specific.

Parameters

name

Definition at line 156 of file VolumeBuilderBase.hpp.

                                                     {
        this->boolean_configs_->boolean_name = name;
        return this->shared_from_this();
    }

SetCopyNo() [1/2]

template<typename U >

DerivedPtr SetCopyNo

(

G4int

pCopyNo

)

Set the copy number for the placement.

Parameters

pCopyNo

Copy number.

Returns

This builder for chaining.

SetCopyNo() [2/2]

template<typename U >

VolumeBuilderBase< U >::DerivedPtr SetCopyNo

(

G4int

pCopyNo

)

Set the copy number for the placement.

Parameters

pCopyNo

Copy number.

Returns

This builder for chaining.

Definition at line 627 of file VolumeBuilderBase.hpp.

                                         {
        explicit_copyno_set_ = static_cast<bool>(pCopyNo);
        this->placement_configs_->copy_no = pCopyNo;
        return this->shared_from_this();
    }

SetLogicalVolume()

template<typename U >

VolumeBuilderBase< U >::DerivedPtr SetLogicalVolume

(

G4LogicalVolume *

logical_volume

)

Directly Provide a Logical Volume Instead of using the builder.

Parameters

logical_volume

Definition at line 189 of file VolumeBuilderBase.hpp.

                                                                  {
        SetLogicalVolume_impl(logical_volume);
        return this->shared_from_this();
    }

SetMother() [1/2]

template<typename U >

DerivedPtr SetMother

(

const VolumeBuilder &

mother

)

Set the mother volume with a builder, or G4VPhysicalVolume or G4VLogicalVolume through implicit conversion.

This does NOT immediately force a build the mother builder, just pre-sets the relationship.

Parameters

mother

BuilderView parameter accepts a builder or a G4VSolid through implicit ctor

Returns

This builder for chaining.

SetMother() [2/2]

template<typename U >

VolumeBuilderBase< U >::DerivedPtr SetMother

(

const VolumeBuilder &

mother

)

Set the mother volume with a builder, or G4VPhysicalVolume or G4VLogicalVolume through implicit conversion.

This does NOT immediately force a build the mother builder, just pre-sets the relationship.

Parameters

mother

BuilderVew parameter accepts a builder or a G4VSolid through implicit ctor

Returns

This builder for chaining.

Definition at line 642 of file VolumeBuilderBase.hpp.

                                                       {
        if (!mother) {
            throw std::runtime_error("Error in VolumeBuilderBase::SetMother,"
                                     "for builder named: \"" + builder_configs_->name + "\"\n"
                                     " no valid mother physical volume provided");
            // We cannot actually fully check this yet because we allow this to be a forward association
            // The logical volume is not required to be constructable before we make a placement.
        }
        this->placement_configs_->mother = mother;
        return this->shared_from_this();
    }

SetPhysOffset() [1/2]

template<typename U >

DerivedPtr SetPhysOffset

(

const DLG4::VolumeBuilders::ThreeVecDimensioner &

offset = {0, 0, 0, VB::Length::mm}

)

Set the translation vector for placement.

Using Set, rotation applies before translation, regardless of order set, just as in G4PVPlacement() You can pass (unit, x, y, z) or use the default unit with (x, y, z).

Examples: SetPhysOffset({ 1, 2, 3, VB::cm}) // 1cm, 2cm, 3cm SetPhysOffset({1, 2, 3}) // Uses default default unit (usually mm) SetDefaultUnit(VB::cm); SetPhysOffset({1, 2, 3}) // 1cm, 2cm, 3cm // or work with raw geant values, must use CLHEP units, not VB: SetDefaultUnit(VB::native); SetPhysOffset({10*CLHEP::mm, 20*CLHEP::mm, 30*CLHEP::mm})

Parameters

offset

Translation vector. See method description for details.

Returns

This builder for chaining.

SetPhysOffset() [2/2]

template<typename U >

VolumeBuilderBase< U >::DerivedPtr SetPhysOffset

(

const DLG4::VolumeBuilders::ThreeVecDimensioner &

offset = {0, 0, 0, VB::Length::mm}

)

Set the translation vector for placement.

Using Set, rotation applies before translation, regardless of order set, just as in G4PVPlacement() You can pass (x, y, z, unit) or use the default unit with (x, y, z).

Examples: SetPhysOffset({ 1, 2, 3, VB::cm}) // 1cm, 2cm, 3cm SetPhysOffset({1, 2, 3}) // Uses default default unit (usually mm) SetDefaultUnit(VB::cm); SetPhysOffset({1, 2, 3}) // 1cm, 2cm, 3cm // or work with raw geant values, must use CLHEP units, not VB: SetDefaultUnit(VB::native); SetPhysOffset({10*CLHEP::mm, 20*CLHEP::mm, 30*CLHEP::mm})

Parameters

offset

Translation vector. See method description for details.

Returns

This builder for chaining.

Definition at line 558 of file VolumeBuilderBase.hpp.

                                                                                       {
        const auto &offset = ProvisionUnits(new_offset);
        placement_configs_->translation = offset;
        PropagateTransform();
        return this->shared_from_this();
    }

SetPhysRotation() [1/2]

template<typename U >

DerivedPtr SetPhysRotation

(

const G4RotationMatrix &

rot

)

Set the rotation matrix for placement.

Using Set, rotation applies before translation, regardless of order set, just as in G4PVPlacement()

Parameters

rot	Pointer to the rotation matrix.

Returns

This builder for chaining.

SetPhysRotation() [2/2]

template<typename U >

VolumeBuilderBase< U >::DerivedPtr SetPhysRotation

(

const G4RotationMatrix &

rot

)

Set the rotation matrix for placement.

Using Set, rotation applies before translation, regardless of order set, just as in G4PVPlacement()

Parameters

rot	Pointer to the rotation matrix.

Returns

This builder for chaining.

Definition at line 535 of file VolumeBuilderBase.hpp.

                                                             {
        G4RotationMatrix nullrot;
        this->placement_configs_->rotation = rot;
        PropagateTransform();
        return this->shared_from_this();
    }

SetPhysTransform() [1/2]

template<typename U >

DerivedPtr SetPhysTransform

(

const UnitlessG4Transform3D &

new_transform

)

Set the G4Transform3D for placment The tranformation provided is meant to be UNITLESS unless you SetDefaultUnit(1).

Otherwise ex: SetDefaultUnit(VB::Length::cm) and proivde a UNITLESS transform. To supply units for each G4Tranform3D separately, just call SetDefaultUnit(unit) before each call. Will overwite/replace rotation and translation.

Parameters

new_transform

Translation vector.

Returns

This builder for chaining.

SetPhysTransform() [2/2]

template<typename U >

VolumeBuilderBase< U >::DerivedPtr SetPhysTransform

(

const UnitlessG4Transform3D &

new_transform

)

Set the G4Transform3D for placment.

The tranformation provided is meant to be in UNITLESS values. Ie the unit is already pre-configured but not included in the values. So passing 5 means 5cm if SetDefault(VB::Length::cm) was set. Otherwise you SetDefaultUnit(VB::roaw), and pass a value that was already multipled by units. To supply different units for each G4Tranform3D separately, just call SetDefaultUnit(unit) before each call. The call will overwite/replace rotation and translation.

Parameters

new_transform

Translation vector.

Returns

This builder for chaining.

Definition at line 575 of file VolumeBuilderBase.hpp.

                                                                     {
        SetPhysRotation(new_transform.getRotation()); // gets a copy on stack
        SetPhysOffset({ (G4ThreeVector)new_transform.getTranslation(), GetEffectiveDefaultUnit()});
        PropagateTransform();
        return this->shared_from_this();
    }

SetSurfaceCheck() [1/2]

template<typename U >

DerivedPtr SetSurfaceCheck

(

G4bool

pSurfChk

)

Set the surface check flag for the placement.

Parameters

pSurfChk

Boolean flag for surface check.

Returns

This builder for chaining.

SetSurfaceCheck() [2/2]

template<typename U >

VolumeBuilderBase< U >::DerivedPtr SetSurfaceCheck

(

G4bool

pSurfChk

)

Set the surface check flag for the placement.

Parameters

pSurfChk

Boolean flag for surface check.

Returns

This builder for chaining.

Definition at line 635 of file VolumeBuilderBase.hpp.

                                                 {
        this->placement_configs_->surface_check = pSurfChk;
        return this->shared_from_this();
    }