G4QSSParameters Class Reference

G4QSSParameters hold parameters for the QSS Integrator driver. It is used to create all QSStepper objects, directly or via the Integration Driver. Checks for consistency of the proposed values. More...

#include <G4QSSParameters.hh>

Public Member Functions
	~G4QSSParameters ()=default
G4int	GetQssOrder ()
G4double	Get_dQRel ()
G4double	Get_dQMin ()
G4int	GetMaxSubsteps ()
G4bool	SetQssOrder (G4int value, G4bool onlyWarn=false)
G4bool	Set_dQRel (G4double dQRel)
G4bool	Set_dQMin (G4double dQMin)
G4bool	SetMaxSubsteps (G4int maxSubsteps)

Static Public Member Functions
static G4QSSParameters *	Instance ()

Detailed Description

G4QSSParameters hold parameters for the QSS Integrator driver. It is used to create all QSStepper objects, directly or via the Integration Driver. Checks for consistency of the proposed values.

Definition at line 48 of file G4QSSParameters.hh.

Constructor & Destructor Documentation

~G4QSSParameters()

G4QSSParameters::~G4QSSParameters ( )

default

Default Destructor.

Member Function Documentation

Get_dQMin()

G4double G4QSSParameters::Get_dQMin ( )

inline

Definition at line 64 of file G4QSSParameters.hh.

{ return fdQMin; }

Referenced by G4QSSMessenger::Get_dQMin().

Get_dQRel()

G4double G4QSSParameters::Get_dQRel ( )

inline

Definition at line 63 of file G4QSSParameters.hh.

{ return fdQRel; }

Referenced by G4QSSMessenger::Get_dQRel().

GetMaxSubsteps()

G4int G4QSSParameters::GetMaxSubsteps ( )

inline

Definition at line 65 of file G4QSSParameters.hh.

{ return fMaxSubsteps; }

Referenced by G4QSSMessenger::GetMaxSubsteps().

GetQssOrder()

G4int G4QSSParameters::GetQssOrder ( )

inline

Accessors.

Definition at line 62 of file G4QSSParameters.hh.

{ return fQssOrder; }

Referenced by G4QSSMessenger::GetQssOrder().

Instance()

G4QSSParameters * G4QSSParameters::Instance ( )

static

Definition at line 44 of file G4QSSParameters.cc.

{
  static G4QSSParameters theQSSParametersSingleton;
  return &theQSSParametersSingleton;
}

Referenced by G4QSSMessenger::Get_dQMin(), G4QSSMessenger::Get_dQRel(), G4QSSMessenger::GetMaxSubsteps(), G4QSSMessenger::GetQssOrder(), and G4QSSMessenger::SetQssOrder().

Set_dQMin()

G4bool G4QSSParameters::Set_dQMin

(

G4double

dQMin

)

Definition at line 52 of file G4QSSParameters.cc.

{ 
  G4bool good_value= dQMin_smallest < value && value < dQMin_biggest;
  if( good_value )
  { 
    fdQMin = value; 
    //-------------
  } 
  else 
  { 
    G4ExceptionDescription errmsg;
    errmsg << " OUT of RANGE: Proposed value of dQMin is not within expected limits: " 
           << " Smallest = " << dQMin_smallest 
           << " Biggest  = " << dQMin_biggest
           << " Proposed value = " << value;
    G4Exception("G4QSSParameters::Set_dQMin", "QSS-Parameters-0002", 
                FatalException, errmsg );
  }
  return good_value;
}

Set_dQRel()

G4bool G4QSSParameters::Set_dQRel

(

G4double

dQRel

)

Definition at line 75 of file G4QSSParameters.cc.

{ 
  G4bool good_value= dQRel_smallest < value && value < dQRel_biggest ;
  if( good_value )
  { 
    fdQRel = value; 
    //-------------
  } 
  else 
  { 
    G4ExceptionDescription errmsg;
    errmsg << " OUT of RANGE: Proposed value of dQRel is not within expected limits: " 
           << " Smallest = " << dQRel_smallest 
           << " Biggest  = " << dQRel_biggest
           << " Proposed value = " << value;
    G4Exception("G4QSSParameters::Set_dQRel", "QSS-Parameters-0003", 
                FatalException, errmsg );
  }
  return good_value;
}

SetMaxSubsteps()

G4bool G4QSSParameters::SetMaxSubsteps

(

G4int

maxSubsteps

)

Definition at line 119 of file G4QSSParameters.cc.

{
  const G4int maxSubstep_smallest= 2;     // Min acceptable value
  const G4int maxSubstep_biggest = 10000; // Maxacceptable value
   
  G4bool good_value= false;
  if( maxSubstep_smallest <= maxSubSteps && maxSubSteps <= maxSubstep_biggest )
  {
    good_value= true;
    fMaxSubsteps = maxSubSteps;
  }
  else
  {
    G4ExceptionDescription err_msg;     
    err_msg << "Requested max-substeps for G4QSStepper= " << maxSubSteps
            << "  is not between "
            << maxSubstep_smallest << "  and " << maxSubstep_biggest;
    G4Exception("G4QSSParameters::SetMaxSubsteps", "QSS-Parameters-0001",
                JustWarning, err_msg );
  }
  return good_value;
}

SetQssOrder()

G4bool G4QSSParameters::SetQssOrder	(	G4int	value,
		G4bool	onlyWarn = false )

Modifiers.

Definition at line 98 of file G4QSSParameters.cc.

{
  G4bool good_value= false;
  if( 2 <= order_val && order_val <= 3 )
  {
    good_value= true;
    fQssOrder = order_val;
  }
  else
  {
    G4ExceptionDescription err_msg;     
    err_msg << "Requested order for G4QSStepper= "
            << order_val << "  is neither 2 nor 3.";
    G4Exception("G4QSSParameters::SetQssOrder", "QSS-Parameters-0001", 
                onlyWarn ? JustWarning : FatalException, err_msg );
  }
  return good_value;
}

Referenced by G4QSSMessenger::SetQssOrder().

---

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

• G4QSSParameters.hh
• G4QSSParameters.cc