G4Field Class Reference

#include <G4Field.hh>

Inheritance diagram for G4Field:

Public Member Functions
virtual G4Field *	Clone () const
virtual G4bool	DoesFieldChangeEnergy () const =0
	G4Field (const G4Field &)
	G4Field (G4bool gravityOn=false)
virtual void	GetFieldValue (const G4double Point[4], G4double *fieldArr) const =0
G4bool	IsGravityActive () const
G4Field &	operator= (const G4Field &p)
void	SetGravityActive (G4bool OnOffFlag)
virtual	~G4Field ()

Static Public Attributes
static constexpr G4int	MAX_NUMBER_OF_COMPONENTS = 24

Private Attributes
G4bool	fGravityActive = false

Detailed Description

Definition at line 55 of file G4Field.hh.

Constructor & Destructor Documentation

G4Field() [1/2]

G4Field::G4Field

(

G4bool

gravityOn = false

)

Definition at line 33 of file G4Field.cc.

  : fGravityActive( gravityOn )
{
}

G4Field() [2/2]

G4Field::G4Field

(

const G4Field &

p

)

Definition at line 49 of file G4Field.cc.

  : fGravityActive(p.fGravityActive)
{
}

~G4Field()

G4Field::~G4Field ( )

virtual

Definition at line 38 of file G4Field.cc.

{
}

Member Function Documentation

Clone()

G4Field * G4Field::Clone ( ) const

virtual

Reimplemented in G4CachedMagneticField, G4DELPHIMagField, G4HarmonicPolMagField, G4LineCurrentMagField, G4QuadrupoleMagField, G4SextupoleMagField, G4TCachedMagneticField< T_Field >, G4TQuadrupoleMagField, G4TUniformMagneticField, G4UniformElectricField, G4UniformGravityField, G4KM_DummyField, and G4UniformMagField.

Definition at line 54 of file G4Field.cc.

{
    G4ExceptionDescription msg;
    msg << "Derived class does not implement cloning,\n"
        << "but Clone method called.\n"
        << "Cannot continue;";
    G4Exception("G4Field::Clone", "GeomField004", FatalException,msg );
    return nullptr;
}

References FatalException, and G4Exception().

Referenced by G4CachedMagneticField::Clone(), and G4FieldManager::Clone().

DoesFieldChangeEnergy()

virtual G4bool G4Field::DoesFieldChangeEnergy ( ) const

pure virtual

Implemented in G4ElectricField, G4MagneticField, G4UniformGravityField, and G4ElectroMagneticField.

Referenced by G4FieldManager::G4FieldManager(), and G4FieldManager::InitialiseFieldChangesEnergy().

GetFieldValue()

virtual void G4Field::GetFieldValue ( const G4double  Point[4], G4double *  fieldArr  ) const

pure virtual

Implemented in PyG4MagneticField, pyG4MagneticField::CB_PyG4MagneticField, G4CachedMagneticField, G4TCachedMagneticField< T_Field >, G4ElectricField, G4ElectroMagneticField, G4MagneticField, G4UniformGravityField, G4UniformElectricField, G4TUniformMagneticField, and G4UniformMagField.

Referenced by G4ErrorSurfaceTrajState::BuildErrorMatrix(), G4ErrorFreeTrajState::G4ErrorFreeTrajState(), G4ElectricFieldModel::GetFieldAtLocation(), G4MagneticFieldModel::GetFieldAtLocation(), G4SynchrotronRadiation::GetMeanFreePath(), G4SynchrotronRadiationInMat::GetMeanFreePath(), G4SynchrotronRadiationInMat::GetPhotonEnergy(), G4SynchrotronRadiation::PostStepDoIt(), G4SynchrotronRadiationInMat::PostStepDoIt(), G4ErrorMagFieldLimitProcess::PostStepGetPhysicalInteractionLength(), and G4ErrorFreeTrajState::PropagateError().

IsGravityActive()

G4bool G4Field::IsGravityActive ( ) const

inline

Definition at line 101 of file G4Field.hh.

{
  return fGravityActive;
}

References fGravityActive.

Referenced by G4CoupledTransportation::AlongStepGetPhysicalInteractionLength(), and G4RepleteEofM::G4RepleteEofM().

operator=()

G4Field & G4Field::operator=

(

const G4Field &

p

)

Definition at line 42 of file G4Field.cc.

{
   if (&p == this) return *this;
   fGravityActive= p.fGravityActive;
   return *this;
}

References fGravityActive.

Referenced by G4ElectroMagneticField::operator=(), G4MagneticField::operator=(), and G4UniformGravityField::operator=().

SetGravityActive()

void G4Field::SetGravityActive ( G4bool  OnOffFlag )

inline

Definition at line 106 of file G4Field.hh.

{ 
  fGravityActive = OnOffFlag; 
}

References fGravityActive.

Field Documentation

fGravityActive

G4bool G4Field::fGravityActive = false

private

Definition at line 96 of file G4Field.hh.

Referenced by IsGravityActive(), operator=(), and SetGravityActive().

MAX_NUMBER_OF_COMPONENTS

constexpr G4int G4Field::MAX_NUMBER_OF_COMPONENTS = 24

staticconstexpr

Definition at line 92 of file G4Field.hh.

Referenced by G4BFieldIntegrationDriver::CurvatureRadius().

---

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

• source/geometry/magneticfield/include/G4Field.hh
• source/geometry/magneticfield/src/G4Field.cc