Import Geant4 11.4.0 source tree
This commit is contained in:
Gabriele Cosmo
@@ -31,8 +31,8 @@
|
||||
// It allows any kind of field (vector, scalar, tensor and any set of them)
|
||||
// to be defined by implementing the inquiry function interface.
|
||||
//
|
||||
// The key method is GetFieldValue( const double Point[4],
|
||||
// ************* double *fieldArr )
|
||||
// The key method is GetFieldValue( const G4double Point[4],
|
||||
// ************* G4double* fieldArr )
|
||||
// Given an input position/time vector 'Point',
|
||||
// this method must return the value of the field in "fieldArr".
|
||||
//
|
||||
@@ -44,68 +44,102 @@
|
||||
// spin. For this a field and its equation of motion must follow the
|
||||
// same convention for the order of field components in the array "fieldArr"
|
||||
|
||||
// Created: John Apostolakis, 10.03.1997
|
||||
// Author: John Apostolakis (CERN), 10.03.1997
|
||||
// -------------------------------------------------------------------
|
||||
#ifndef G4FIELD_HH
|
||||
#define G4FIELD_HH
|
||||
|
||||
#include "G4Types.hh"
|
||||
#include "G4FieldParameters.hh"
|
||||
#include "globals.hh"
|
||||
|
||||
/**
|
||||
* @brief G4Field is the abstract class for any kind of field.
|
||||
* It allows any kind of field (vector, scalar, tensor and any set of them)
|
||||
* to be defined by implementing the inquiry function interface.
|
||||
* A field must co-work with a corresponding Equation of Motion, to
|
||||
* enable the integration of a particle's position, momentum and, optionally,
|
||||
* spin. For this a field and its equation of motion must follow the same
|
||||
* convention for the order of field components.
|
||||
*/
|
||||
|
||||
class G4Field
|
||||
{
|
||||
public: // with description
|
||||
public:
|
||||
|
||||
G4Field( G4bool gravityOn = false);
|
||||
G4Field( const G4Field& );
|
||||
virtual ~G4Field();
|
||||
G4Field& operator = (const G4Field& p);
|
||||
/**
|
||||
* Constructor for G4Field.
|
||||
* @param[in] gravityOn Flag to indicate if gravity is enabled or not.
|
||||
*/
|
||||
G4Field(G4bool gravityOn = false);
|
||||
|
||||
virtual void GetFieldValue( const G4double Point[4],
|
||||
G4double* fieldArr ) const = 0;
|
||||
// Given the position time vector 'Point',
|
||||
// return the value of the field in the array fieldArr.
|
||||
// Notes:
|
||||
// 1) The 'Point' vector has the following structure:
|
||||
// Point[0] is x ( position, in Geant4 units )
|
||||
// Point[1] is y
|
||||
// Point[2] is z
|
||||
// Point[3] is t ( time, in Geant4 units )
|
||||
// 2) The convention for the components of the field
|
||||
// array 'fieldArr' are determined by the type of field.
|
||||
// See for example the class G4ElectroMagneticField.
|
||||
/**
|
||||
* Default virtual Destructor.
|
||||
*/
|
||||
virtual ~G4Field() = default;
|
||||
|
||||
virtual G4bool DoesFieldChangeEnergy() const = 0;
|
||||
// Each type/class of field should respond this accordingly
|
||||
// For example:
|
||||
// - an electric field should return "true"
|
||||
// - a pure magnetic field should return "false"
|
||||
/**
|
||||
* Copy constructor and assignment operator.
|
||||
*/
|
||||
G4Field( const G4Field& p) = default;
|
||||
G4Field& operator = (const G4Field& p);
|
||||
|
||||
inline G4bool IsGravityActive() const;
|
||||
/**
|
||||
* Given the position time vector 'Point', returns the value of the
|
||||
* field in the array 'fieldArr'. Notes:
|
||||
* 1) The 'Point' vector has the following structure:
|
||||
* Point[0] is x ( position, in Geant4 units )
|
||||
* Point[1] is y
|
||||
* Point[2] is z
|
||||
* Point[3] is t ( time, in Geant4 units )
|
||||
* 2) The convention for the components of the field array 'fieldArr'
|
||||
* are determined by the type of field.
|
||||
* @param[in] Point The position time vector.
|
||||
* @param[out] fieldArr The field array in output.
|
||||
*/
|
||||
virtual void GetFieldValue( const G4double Point[4],
|
||||
G4double* fieldArr ) const = 0;
|
||||
|
||||
/**
|
||||
* Each type/class of field should respond the field does change energy.
|
||||
* For example:
|
||||
* - an electric field should return "true"
|
||||
* - a pure magnetic field should return "false"
|
||||
*/
|
||||
virtual G4bool DoesFieldChangeEnergy() const = 0;
|
||||
|
||||
/**
|
||||
* Returns the field type-ID, "kUserFieldType".
|
||||
* This should be overriden in derived classes.
|
||||
*/
|
||||
virtual G4FieldType GetFieldType() const { return kUserFieldType; }
|
||||
|
||||
/**
|
||||
* Replies if the field includes gravity.
|
||||
* @returns true if the field does include gravity.
|
||||
*/
|
||||
inline G4bool IsGravityActive() const { return fGravityActive; }
|
||||
// Does this field include gravity?
|
||||
|
||||
inline void SetGravityActive( G4bool OnOffFlag );
|
||||
/**
|
||||
* Sets the gravity flag.
|
||||
*/
|
||||
inline void SetGravityActive(G4bool OnOffFlag) { fGravityActive = OnOffFlag; }
|
||||
|
||||
virtual G4Field* Clone() const;
|
||||
// Implements cloning, needed by multi-threading
|
||||
/**
|
||||
* Interface method to implement cloning, needed by multi-threading.
|
||||
* Here issuing a fatal exception, as expecting this to be implemented
|
||||
* concretely in derived classes.
|
||||
*/
|
||||
virtual G4Field* Clone() const;
|
||||
|
||||
static constexpr G4int MAX_NUMBER_OF_COMPONENTS = 24;
|
||||
public:
|
||||
|
||||
static constexpr G4int MAX_NUMBER_OF_COMPONENTS = 24;
|
||||
|
||||
private:
|
||||
|
||||
G4bool fGravityActive = false;
|
||||
G4bool fGravityActive = false;
|
||||
};
|
||||
|
||||
// Inline methods ...
|
||||
|
||||
inline G4bool G4Field::IsGravityActive() const
|
||||
{
|
||||
return fGravityActive;
|
||||
}
|
||||
|
||||
inline void G4Field::SetGravityActive( G4bool OnOffFlag )
|
||||
{
|
||||
fGravityActive = OnOffFlag;
|
||||
}
|
||||
|
||||
#endif
|
||||
|
||||
Reference in New Issue
Block a user