BDSIM
BDSIM is a Geant4 extension toolkit for simulation of particle transport in accelerator beamlines.
Loading...
Searching...
No Matches
Public Member Functions | Private Member Functions | Private Attributes | Static Private Attributes
BDSVisFieldModel Class Reference
Inheritance diagram for BDSVisFieldModel:
Inheritance graph
Collaboration diagram for BDSVisFieldModel:
Collaboration graph

Public Member Functions

 BDSVisFieldModel (const std::vector< BDSFieldQueryInfo * > &queriesIn)
 
 BDSVisFieldModel (const BDSVisFieldModel &)=delete
 
BDSVisFieldModeloperator= (const BDSVisFieldModel &)=delete
 
virtual void DescribeYourselfTo (G4VGraphicsScene &sceneHandler)
 

Private Member Functions

G4double CalculateArrowLength (const BDSFieldQueryInfo *query) const
 Return the minimum of 0.8 x the step length in x,y,z.
 
G4double QIL (const BDSFieldQueryInfo::QueryDimensionInfo &qi) const
 Query Info Length. For one dimension, return 0.8 x step size.
 
G4ThreeVector BoxHalfSize (const BDSFieldQueryInfo *qi) const
 

Private Attributes

const std::vector< BDSFieldQueryInfo * > queries
 Cache of queries.
 
G4VisAttributes * pointVisB
 The vis attributes for a zero-field marker.
 
G4VisAttributes * pointVisE
 The vis attributes for a zero-field marker.
 

Static Private Attributes

static G4int instanceCounter = 0
 

Detailed Description

Definition at line 33 of file BDSVisFieldModel.hh.

Constructor & Destructor Documentation

◆ BDSVisFieldModel()

BDSVisFieldModel::BDSVisFieldModel ( const std::vector< BDSFieldQueryInfo * > &  queriesIn)
explicit

Definition at line 51 of file BDSVisFieldModel.cc.

◆ ~BDSVisFieldModel()

BDSVisFieldModel::~BDSVisFieldModel ( )
virtual

Definition at line 69 of file BDSVisFieldModel.cc.

Member Function Documentation

◆ BoxHalfSize()

G4ThreeVector BDSVisFieldModel::BoxHalfSize ( const BDSFieldQueryInfo qi) const
private

Return a suitable vector of half sizes (x,y,z) for a box to represent 1 voxel of a field query in 3D even if it's 1,2 or 3D. If 2D, the 3rd dimension is 1% of the minimum of the other 2. If 1D, it's 20% of the step size of that 1 dimension.

Definition at line 275 of file BDSVisFieldModel.cc.

◆ CalculateArrowLength()

G4double BDSVisFieldModel::CalculateArrowLength ( const BDSFieldQueryInfo query) const
private

Return the minimum of 0.8 x the step length in x,y,z.

Definition at line 260 of file BDSVisFieldModel.cc.

References QIL().

Here is the call graph for this function:

◆ DescribeYourselfTo()

void BDSVisFieldModel::DescribeYourselfTo ( G4VGraphicsScene &  sceneHandler)
virtual

Definition at line 75 of file BDSVisFieldModel.cc.

◆ QIL()

G4double BDSVisFieldModel::QIL ( const BDSFieldQueryInfo::QueryDimensionInfo qi) const
private

Query Info Length. For one dimension, return 0.8 x step size.

Definition at line 266 of file BDSVisFieldModel.cc.

Referenced by CalculateArrowLength().

Here is the caller graph for this function:

Field Documentation

◆ instanceCounter

G4int BDSVisFieldModel::instanceCounter = 0
staticprivate

Counter variable as we need to construct a new one of this class and have it have a unique name.

Definition at line 49 of file BDSVisFieldModel.hh.

◆ pointVisB

G4VisAttributes* BDSVisFieldModel::pointVisB
private

The vis attributes for a zero-field marker.

Definition at line 67 of file BDSVisFieldModel.hh.

◆ pointVisE

G4VisAttributes* BDSVisFieldModel::pointVisE
private

The vis attributes for a zero-field marker.

Definition at line 68 of file BDSVisFieldModel.hh.

◆ queries

const std::vector<BDSFieldQueryInfo*> BDSVisFieldModel::queries
private

Cache of queries.

Definition at line 64 of file BDSVisFieldModel.hh.


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