G4UniformGravityField Class Reference

G4UniformGravityField is a class for defining a uniform gravitation field. More...

#include <G4UniformGravityField.hh>

Inheritance diagram for G4UniformGravityField:

Public Member Functions
	G4UniformGravityField (const G4ThreeVector &FieldVector)
	G4UniformGravityField (const G4double gy=-9.81 *CLHEP::m/CLHEP::s/CLHEP::s)
	~G4UniformGravityField () override=default
	G4UniformGravityField (const G4UniformGravityField &p)
G4UniformGravityField &	operator= (const G4UniformGravityField &p)
G4bool	DoesFieldChangeEnergy () const override
void	GetFieldValue (const G4double Point[4], G4double *field) const override
G4Field *	Clone () const override
G4FieldType	GetFieldType () const override
Public Member Functions inherited from G4Field
	G4Field (G4bool gravityOn=false)
virtual	~G4Field ()=default
	G4Field (const G4Field &p)=default
G4Field &	operator= (const G4Field &p)
G4bool	IsGravityActive () const
void	SetGravityActive (G4bool OnOffFlag)

Additional Inherited Members
Static Public Attributes inherited from G4Field
static constexpr G4int	MAX_NUMBER_OF_COMPONENTS = 24

Detailed Description

G4UniformGravityField is a class for defining a uniform gravitation field.

Definition at line 49 of file G4UniformGravityField.hh.

Constructor & Destructor Documentation

G4UniformGravityField() [1/3]

G4UniformGravityField::G4UniformGravityField

(

const G4ThreeVector &

FieldVector

)

Constructor for G4UniformGravityField, a field with value equal to 'FieldVector'.

Parameters

[in]

FieldVector

The field vector value.

Definition at line 38 of file G4UniformGravityField.cc.

  : G4Field ( true ) //  Gravity flag *on*
{
  fFieldComponents[0] = FieldVector.x();
  fFieldComponents[1] = FieldVector.y();
  fFieldComponents[2] = FieldVector.z();
}

Referenced by Clone(), G4UniformGravityField(), operator=(), and ~G4UniformGravityField().

G4UniformGravityField() [2/3]

G4UniformGravityField::G4UniformGravityField

(

const G4double

gy = -9.81*CLHEP::m/CLHEP::s/CLHEP::s

)

Alternative constructor for G4UniformGravityField.

Parameters

[in]

gy

The gravitation field value (default is the Standard Gravitational field on earth's surface.

Definition at line 47 of file G4UniformGravityField.cc.

  : G4Field ( true ) 
{
  fFieldComponents[0] = 0.0;
  fFieldComponents[1] = gy;
  fFieldComponents[2] = 0.0;
}

~G4UniformGravityField()

G4UniformGravityField::~G4UniformGravityField ( )

overridedefault

Default Destructor.

G4UniformGravityField() [3/3]

G4UniformGravityField::G4UniformGravityField

(

const G4UniformGravityField &

p

)

Copy constructor and assignment operator.

Definition at line 55 of file G4UniformGravityField.cc.

  : G4Field(p)
{
  for (auto i=0; i<3; ++i)
  {
    fFieldComponents[i] = p.fFieldComponents[i];
  }
}

Member Function Documentation

Clone()

G4Field * G4UniformGravityField::Clone ( ) const

overridevirtual

Returns a pointer to a new allocated clone of this object.

Reimplemented from G4Field.

Definition at line 76 of file G4UniformGravityField.cc.

{
  return new G4UniformGravityField( G4ThreeVector(fFieldComponents[0],
                                                  fFieldComponents[1],
                                                  fFieldComponents[2]) );
}

DoesFieldChangeEnergy()

G4bool G4UniformGravityField::DoesFieldChangeEnergy ( ) const

inlineoverridevirtual

The field can change track energy, so returning true.

Implements G4Field.

Definition at line 81 of file G4UniformGravityField.hh.

{ return true; }

GetFieldType()

G4FieldType G4UniformGravityField::GetFieldType ( ) const

inlineoverridevirtual

Returns the field type ID, 'kGravity'.

Reimplemented from G4Field.

Definition at line 96 of file G4UniformGravityField.hh.

{ return kGravity; }

GetFieldValue()

void G4UniformGravityField::GetFieldValue ( const G4double Point[4], G4double * field ) const

overridevirtual

Returns the field value 'field' on given time 'Point'.

Implements G4Field.

Definition at line 85 of file G4UniformGravityField.cc.

{
   G[0]= fFieldComponents[0];
   G[1]= fFieldComponents[1];
   G[2]= fFieldComponents[2];
}

operator=()

G4UniformGravityField & G4UniformGravityField::operator=

(

const G4UniformGravityField &

p

)

Definition at line 65 of file G4UniformGravityField.cc.

{
  if (&p == this) { return *this; }
  G4Field::operator=(p); 
  for (auto i=0; i<3; ++i)
  {
    fFieldComponents[i] = p.fFieldComponents[i];
  }
  return *this;
}

---

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

• G4UniformGravityField.hh
• G4UniformGravityField.cc