F01FieldSetup Class Reference

#include <F01FieldSetup.hh>

Collaboration diagram for F01FieldSetup:

Public Member Functions
	F01FieldSetup (G4ThreeVector)
	F01FieldSetup ()
virtual	~F01FieldSetup ()
void	SetStepperType (G4int i)
void	SetStepper ()
void	SetMinStep (G4double s)
void	InitialiseAll ()
void	CreateStepperAndChordFinder ()
void	SetFieldValue (G4ThreeVector fieldVector)
void	SetFieldValue (G4double fieldValue)
G4ThreeVector	GetConstantFieldValue ()

Protected Member Functions
G4FieldManager *	GetGlobalFieldManager ()

Protected Attributes
G4FieldManager *	fFieldManager
G4ChordFinder *	fChordFinder
G4Mag_UsualEqRhs *	fEquation
G4MagneticField *	fMagneticField
G4MagIntegratorStepper *	fStepper
G4int	fStepperType
G4double	fMinStep
F01FieldMessenger *	fFieldMessenger

Detailed Description

Definition at line 57 of file F01FieldSetup.hh.

Constructor & Destructor Documentation

F01FieldSetup::F01FieldSetup

(

G4ThreeVector

fieldVector

)

Definition at line 76 of file F01FieldSetup.cc.

 : fFieldManager(0),
   fChordFinder(0),
   fEquation(0),
   fMagneticField(new G4UniformMagField(fieldVector)),
   fStepper(0),
   fStepperType(0),
   fMinStep(0.),
   fFieldMessenger(0)
{
  G4cout << " F01FieldSetup: magnetic field set to Uniform( "
         << fieldVector << " ) " << G4endl;
  InitialiseAll();
}

Here is the call graph for this function:

F01FieldSetup::F01FieldSetup

(

)

Definition at line 93 of file F01FieldSetup.cc.

 : fFieldManager(0),
   fChordFinder(0),
   fEquation(0),
   fMagneticField(new G4UniformMagField(G4ThreeVector())),
   fStepper(0),
   fStepperType(0),
   fMinStep(0.),
   fFieldMessenger(0)
{
  G4cout << " F01FieldSetup: magnetic field set to Uniform( 0.0, 0, 0 ) "
         << G4endl;
  InitialiseAll();
}

Here is the call graph for this function:

F01FieldSetup::~F01FieldSetup ( )

virtual

Definition at line 127 of file F01FieldSetup.cc.

{
  delete fMagneticField;
  delete fChordFinder;
  delete fStepper;
  delete fFieldMessenger;
}

Member Function Documentation

void F01FieldSetup::CreateStepperAndChordFinder

(

)

Definition at line 137 of file F01FieldSetup.cc.

{
  // Update field

  G4cout<< " F01FieldSetup::CreateStepperAndChordFinder() called "
        << " to reset Stepper."  << G4endl;

  SetStepper();
  G4cout<<"The minimal step is equal to "<<fMinStep/mm<<" mm"<<G4endl;

  fFieldManager->SetDetectorField(fMagneticField );

  if (fChordFinder) delete fChordFinder;

  fChordFinder = new G4ChordFinder( fMagneticField, fMinStep,fStepper );

  fFieldManager->SetChordFinder( fChordFinder );
}

Here is the call graph for this function:

Here is the caller graph for this function:

G4ThreeVector F01FieldSetup::GetConstantFieldValue

(

)

G4FieldManager * F01FieldSetup::GetGlobalFieldManager ( )

protected

Definition at line 310 of file F01FieldSetup.cc.

{
  //  Utility method

  return G4TransportationManager::GetTransportationManager()
           ->GetFieldManager();
}

Here is the call graph for this function:

Here is the caller graph for this function:

void F01FieldSetup::InitialiseAll

(

)

Definition at line 110 of file F01FieldSetup.cc.

{
  fFieldMessenger = new F01FieldMessenger(this);
 
  fEquation = new G4Mag_UsualEqRhs(fMagneticField);
 
  fMinStep     = 1.0*mm; // minimal step of 1 mm is default

  fStepperType = 4;      // ClassicalRK4 is default stepper

  fFieldManager = G4TransportationManager::GetTransportationManager()
                    ->GetFieldManager();
  CreateStepperAndChordFinder();
}

Here is the call graph for this function:

Here is the caller graph for this function:

void F01FieldSetup::SetFieldValue

(

G4ThreeVector

fieldVector

)

Definition at line 283 of file F01FieldSetup.cc.

{
  // Set the value of the Global Field

  if (fMagneticField) delete fMagneticField;
 
  if (fieldVector != G4ThreeVector(0.,0.,0.))
  {
    fMagneticField = new G4UniformMagField(fieldVector);
  }
  else
  {
    // If the new field's value is Zero, signal it as below
    // so that it is not used for propagation.
    fMagneticField = 0;
  }

  // Set this as the field of the global Field Manager
  GetGlobalFieldManager()->SetDetectorField(fMagneticField);

  // Now notify equation of new field
  fEquation->SetFieldObj( fMagneticField );

}

Here is the call graph for this function:

Here is the caller graph for this function:

void F01FieldSetup::SetFieldValue

(

G4double

fieldValue

)

Definition at line 248 of file F01FieldSetup.cc.

{
  // Set the value of the Global Field to fieldValue along Z

#ifdef G4VERBOSE
  G4cout << "Setting Field strength to "
         << fieldStrength / gauss  << " Gauss."; // << G4endl;
#endif

  G4ThreeVector fieldSetVec(0.0, 0.0, fieldStrength);
  this->SetFieldValue( fieldSetVec );

#ifdef G4VERBOSE
  G4double fieldValue[6],  position[4];
  position[0] = position[1] = position[2] = position[3] = 0.0;
  if ( fieldStrength != 0.0 ) {
    fMagneticField->GetFieldValue( position, fieldValue);
    G4ThreeVector fieldVec(fieldValue[0], fieldValue[1], fieldValue[2]);
    // G4cout << " fMagneticField is now " << fMagneticField
    G4cout << " Magnetic field vector is "
           << fieldVec / gauss << " G " << G4endl;
  } else {
    if ( fMagneticField == 0 )
      G4cout << " Magnetic field pointer is null." << G4endl;
    else
      G4Exception("F01FieldSetup::SetFieldValue(double)",
                  "IncorrectForZeroField",
                  FatalException,
                  "fMagneticField ptr should be set to 0 for no field.");
  }
#endif
}

Here is the call graph for this function:

void F01FieldSetup::SetMinStep ( G4double  s )

inline

Definition at line 70 of file F01FieldSetup.hh.

{ fMinStep = s; }

Here is the caller graph for this function:

void F01FieldSetup::SetStepper

(

)

Definition at line 158 of file F01FieldSetup.cc.

{
// Set stepper according to the stepper type

  if (fStepper) delete fStepper;

  switch ( fStepperType )
  {
    case 0:
      fStepper = new G4ExplicitEuler( fEquation );
      G4cout<<"G4ExplicitEuler is chosen."<<G4endl;
      break;
    case 1:
      fStepper = new G4ImplicitEuler( fEquation );
      G4cout<<"G4ImplicitEuler is chosen"<<G4endl;
      break;
    case 2:
      fStepper = new G4SimpleRunge( fEquation );
      G4cout<<"G4SimpleRunge is chosen"<<G4endl;
      break;
    case 3:
      fStepper = new G4SimpleHeum( fEquation );
      G4cout<<"G4SimpleHeum is chosen"<<G4endl;
      break;
    case 4:
      fStepper = new G4ClassicalRK4( fEquation );
      G4cout<<"G4ClassicalRK4 (default) is chosen"<<G4endl;
      break;
    case 5:
      fStepper = new G4HelixExplicitEuler( fEquation );
      G4cout<<"G4HelixExplicitEuler is chosen"<<G4endl;
      break;
    case 6:
      fStepper = new G4HelixImplicitEuler( fEquation );
      G4cout<<"G4HelixImplicitEuler is chosen"<<G4endl;
      break;
    case 7:
      fStepper = new G4HelixSimpleRunge( fEquation );
      G4cout<<"G4HelixSimpleRunge is chosen"<<G4endl;
      break;
    case 8:
      fStepper = new G4CashKarpRKF45( fEquation );
      G4cout<<"G4CashKarpRKF45 is chosen"<<G4endl;
      break;
    case 9:
      fStepper = new G4RKG3_Stepper( fEquation );
      G4cout<<"G4RKG3_Stepper is chosen"<<G4endl;
      break;
    case 10: 
       fStepper = new G4ExactHelixStepper( fEquation );   
       G4cout<<"G4ExactHelixStepper is chosen"<<G4endl;
       break;
    case 11: 
       fStepper = new G4HelixMixedStepper( fEquation );  
       G4cout<<"G4HelixMixedStepper is chosen"<<G4endl;
       break;
    case 12: 
       fStepper = new G4ConstRK4( fEquation ); 
       G4cout<<"G4ConstRK4 Stepper is chosen"<<G4endl;
       break;
    case 13:
      fStepper = new G4NystromRK4( fEquation );
      G4cout<<" G4NystromRK4 Stepper is chosen"<<G4endl;
      break;
    case 14:      
    case 23:
      fStepper = new G4BogackiShampine23( fEquation );
      G4cout<<"G4BogackiShampine23 Stepper is chosen"<<G4endl;
      break;
    case 15:
    case 45:       
      fStepper = new G4BogackiShampine45( fEquation );
      G4cout<<"G4BogackiShampine45 Stepper is chosen"<<G4endl;
      break;
    case 457:
    case 745:
      fStepper = new G4DormandPrince745( fEquation );
      G4cout<<"G4DormandPrince745 Stepper is chosen"<<G4endl;       
      break;
    default:
      fStepper = new G4ClassicalRK4( fEquation );
      G4cout<<"G4ClassicalRK4 Stepper (default) is chosen"<<G4endl;
      // fStepper = new G4DormandPrince745( fEquation );
      // G4cout<<"G4DormandPrince745 (default) Stepper is chosen"<<G4endl;             
      break;      
  }
}

Here is the caller graph for this function:

void F01FieldSetup::SetStepperType ( G4int  i )

inline

Definition at line 65 of file F01FieldSetup.hh.

     { fStepperType = i; CreateStepperAndChordFinder(); }

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

G4ChordFinder* F01FieldSetup::fChordFinder

protected

Definition at line 86 of file F01FieldSetup.hh.

G4Mag_UsualEqRhs* F01FieldSetup::fEquation

protected

Definition at line 87 of file F01FieldSetup.hh.

G4FieldManager* F01FieldSetup::fFieldManager

protected

Definition at line 85 of file F01FieldSetup.hh.

F01FieldMessenger* F01FieldSetup::fFieldMessenger

protected

Definition at line 95 of file F01FieldSetup.hh.

G4MagneticField* F01FieldSetup::fMagneticField

protected

Definition at line 88 of file F01FieldSetup.hh.

G4double F01FieldSetup::fMinStep

protected

Definition at line 93 of file F01FieldSetup.hh.

G4MagIntegratorStepper* F01FieldSetup::fStepper

protected

Definition at line 90 of file F01FieldSetup.hh.

G4int F01FieldSetup::fStepperType

protected

Definition at line 91 of file F01FieldSetup.hh.

---

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

• source/geant4.10.03.p02/examples/extended/field/field01/include/F01FieldSetup.hh
• source/geant4.10.03.p02/examples/extended/field/field01/src/F01FieldSetup.cc