Skip to content

Commit

Permalink
Merge pull request #113 from rest-for-physics/mariajmz_fano
Browse files Browse the repository at this point in the history 
Get Fano factor from Garfield
  • Loading branch information
@mariajmz
mariajmz authored May 1, 2024
2 parents df38ee6 + ac0119a commit 985cd11
Show file tree
Hide file tree
Showing 2 changed files with 82 additions and 23 deletions.
14 changes: 10 additions & 4 deletions inc/TRestDetectorGas.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ class TRestDetectorGas : public TRestDetectorDriftVolume {
void InitFromConfigFile() override;
std::string ConstructFilename();

void AddGasComponent(std::string gasName, Double_t fraction);
void AddGasComponent(const std::string& gasName, Double_t fraction);

void GenerateGasFile();

Expand All @@ -127,7 +127,7 @@ class TRestDetectorGas : public TRestDetectorDriftVolume {

public:
TRestDetectorGas();
TRestDetectorGas(const char* configFilename, std::string name = "", bool gasGeneration = false,
TRestDetectorGas(const char* configFilename, const std::string& name = "", bool gasGeneration = false,
bool test = false);
~TRestDetectorGas();

Expand All @@ -149,7 +149,7 @@ class TRestDetectorGas : public TRestDetectorDriftVolume {

void CalcGarField(double Emin, double Emax, int n);

Int_t Write(const char* name = 0, Int_t option = 0, Int_t bufsize = 0) override;
Int_t Write(const char* name = nullptr, Int_t option = 0, Int_t bufsize = 0) override;

void InitFromRootFile() override;

Expand Down Expand Up @@ -223,7 +223,7 @@ class TRestDetectorGas : public TRestDetectorDriftVolume {
return GetAttachmentCoefficient(fElectricField * units("V/cm"));
}

void GetGasWorkFunction();
void GetGasWorkFunctionOld();

/// Returns the gas fraction in volume for component *n*.
inline Double_t GetGasComponentFraction(Int_t n) {
Expand All @@ -236,6 +236,12 @@ class TRestDetectorGas : public TRestDetectorDriftVolume {
return fGasComponentFraction[n];
}

/// Returns the gas fano factor
Double_t GetGasFanoFactor() const;

/// Returns the gas work function in eV
Double_t GetGasWorkFunction() const;

/// Return pointer to Garfield::MediumGas for gas properties
inline MediumMagboltz* GetGasMedium() const { return fGasMedium; };

Expand Down
91 changes: 72 additions & 19 deletions src/TRestDetectorGas.cxx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -246,15 +246,16 @@ TRestDetectorGas::TRestDetectorGas() : TRestDetectorDriftVolume() {
/// section. \param name The name of the TRestDetectorGas section to be read. \param
/// gasGeneration Parameter allowing to activate the gas generation.
///
TRestDetectorGas::TRestDetectorGas(const char* configFilename, string name, bool gasGeneration, bool test)
TRestDetectorGas::TRestDetectorGas(const char* configFilename, const string& name, bool gasGeneration,
bool test)
: TRestDetectorDriftVolume() {
Initialize();
fGasGeneration = gasGeneration;

fTest = test;

if (strcmp(configFilename, "server") == 0) {
LoadConfigFromElement(StringToElement("<TRestDetectorGas name=\"" + name + "\" file=\"server\"/>"),
LoadConfigFromElement(StringToElement("<TRestDetectorGas name=\"" + name + R"(" file="server"/>)"),
nullptr);
} else {
fConfigFileName = configFilename;
Expand Down Expand Up @@ -432,24 +433,26 @@ void TRestDetectorGas::CalcGarField(double Emin, double Emax, int n) {
/////////////////////////////////////////////
/// \brief Adds a new element/compound to the gas.
///
/// This method is private to make gas intialization possible only through an
/// This method is private to make gas initialization possible only through an
/// RML file. This might change if necessary.
///
/// \param gasName A gas element/compound name valid in Garfield++.
/// \param fraction The element fraction in volume.
///
void TRestDetectorGas::AddGasComponent(string gasName, Double_t fraction) {
void TRestDetectorGas::AddGasComponent(const string& gasName, Double_t fraction) {
RESTDebug << "Entering ... TRestDetectorGas::AddGasComponent( gasName=" << gasName
<< " , fraction=" << fraction << " )" << RESTendl;

fGasComponentName.push_back(gasName);
fGasComponentName.emplace_back(gasName);
fGasComponentFraction.push_back(fraction);
fNofGases++;
}

/*
// This was just a test to try to Get the calculated W for the gas definition.
// However, I tested with Xe+TMA and I got an error message that TMA
// photoncrossection database is not available
void TRestDetectorGas::GetGasWorkFunction() {
#if defined USE_Garfield
RESTEssential << __PRETTY_FUNCTION__ << RESTendl;
Expand Down Expand Up @@ -493,6 +496,56 @@ void TRestDetectorGas::GetGasWorkFunction() {
<< endl;
#endif
}
*/

// Get the fano factor from Garfield::MediumMagboltz
// User need to have installed the last version of
// Garfield to this to work

Double_t TRestDetectorGas::GetGasFanoFactor() const {
#if defined USE_Garfield
if (fStatus != RESTGAS_GASFILE_LOADED) {
RESTDebug << "-- Error : " << __PRETTY_FUNCTION__ << RESTendl;
RESTDebug << "-- Error : Gas file was not loaded!" << RESTendl;
return 0;
}

RESTInfo << "Calling Garfield directly to fetch Fano factor" << RESTendl;
const auto fanoFactor = fGasMedium->GetFanoFactor();

if (fanoFactor == 0.) {
runtime_error("Fano Factor is 0! This REST is not compiled with the last version of Garfield");
}
return fanoFactor;
#else
cerr << "This REST is not compiled with garfield, Do not use Fano "
"Factor from TRestDetectorGas!"
<< endl
<< "Please define the Fano factor in each process!" << endl;
throw runtime_error("This REST is not compiled with garfield, cannot retrieve the Fano Factor");
#endif
}

Double_t TRestDetectorGas::GetGasWorkFunction() const {
#if defined USE_Garfield
if (fStatus != RESTGAS_GASFILE_LOADED) {
RESTDebug << "-- Error : " << __PRETTY_FUNCTION__ << RESTendl;
RESTDebug << "-- Error : Gas file was not loaded!" << RESTendl;
return 0;
}

RESTInfo << "Calling Garfield directly to fetch the work function" << RESTendl;
const auto workFunction = fGasMedium->GetW();

if (workFunction == 0.) {
throw runtime_error("Work Function is 0! This should never happen");
}
return workFunction;
#else
throw runtime_error(
"This REST is not compiled with garfield, cannot retrieve the work function from the gas");
#endif
}

/////////////////////////////////////////////
/// \brief Loads the gas parameters that define the gas calculation
Expand Down Expand Up @@ -527,9 +580,9 @@ void TRestDetectorGas::InitFromConfigFile() {
AddGasComponent(gasName, gasFraction);
gasComponentDefinition = GetNextElement(gasComponentDefinition);
}
if (fNofGases == 0 && fMaterial != "") {
if (fNofGases == 0 && !fMaterial.empty()) {
vector<string> componentsdef = Split(fMaterial, " ");
for (auto componentdef : componentsdef) {
for (const auto& componentdef : componentsdef) {
vector<string> componentdefpair = Split(componentdef, ":");
if (componentdefpair.size() != 2) {
continue;
Expand Down Expand Up @@ -739,16 +792,16 @@ string TRestDetectorGas::FindGasFile(string name) {
absoluteName = TRestTools::DownloadRemoteFile((string)fGasServer + "/" + name, true);
}

if (absoluteName == "") {
if (absoluteName.empty()) {
RESTInfo << "Trying to find the gasFile locally" << RESTendl;
absoluteName = SearchFile(name);
if (absoluteName == "") {
if (absoluteName.empty()) {
RESTWarning << "-- Warning : No sucess finding local gas file definition." << RESTendl;
RESTWarning << "-- Warning : Gas file definition does not exist." << RESTendl;
RESTInfo << "To generate a new gasFile enable gas generation in TRestDetectorGas "
"constructor"
<< RESTendl;
RESTInfo << "TRestDetectorGas ( \"gasDefinition.rml\", \"gas Name\", true );" << RESTendl;
RESTInfo << R"(TRestDetectorGas ( "gasDefinition.rml", "gas Name", true );)" << RESTendl;
RESTInfo << "Further details can be found at TRestDetectorGas class definition and "
"tutorial."
<< RESTendl;
Expand Down Expand Up @@ -786,7 +839,7 @@ TString TRestDetectorGas::GetGasMixture() {
string TRestDetectorGas::ConstructFilename() {
RESTDebug << "Entering ... TRestDetectorGas::ConstructFilename( )" << RESTendl;

string name = "";
string name;
char tmpStr[256];
for (int n = 0; n < fNofGases; n++) {
if (n > 0) name += "-";
Expand Down Expand Up @@ -917,8 +970,8 @@ void TRestDetectorGas::PlotDriftVelocity(Double_t eMin, Double_t eMax, Int_t nSt
driftVel[i] = GetDriftVelocity() * units("cm/us");
}

TCanvas* c = new TCanvas("Drift velocity", " ");
TGraph* fDriftVel = new TGraph(nSteps, &eField[0], &driftVel[0]);
auto c = new TCanvas("Drift velocity", " ");
auto fDriftVel = new TGraph(nSteps, &eField[0], &driftVel[0]);
TString str;
str.Form("Drift Velocity for %s (Pressure: %3.1lf bar)", GetName(), this->GetPressure());
fDriftVel->SetTitle(str);
Expand Down Expand Up @@ -950,8 +1003,8 @@ void TRestDetectorGas::PlotLongitudinalDiffusion(Double_t eMin, Double_t eMax, I
longDiff[i] = 10. * GetLongitudinalDiffusion(); // to express it in mm/sqrt(cm)
}

TCanvas* c = new TCanvas("Longitudinal diffusion", " ");
TGraph* fLongDiff = new TGraph(nSteps, &eField[0], &longDiff[0]);
auto c = new TCanvas("Longitudinal diffusion", " ");
auto fLongDiff = new TGraph(nSteps, &eField[0], &longDiff[0]);
TString str;
str.Form("Longitudinal diffusion for %s (Pressure: %3.1lf bar)", GetName(), this->GetPressure());
fLongDiff->SetTitle(str);
Expand Down Expand Up @@ -983,8 +1036,8 @@ void TRestDetectorGas::PlotTransversalDiffusion(Double_t eMin, Double_t eMax, In
transDiff[i] = 10. * GetTransversalDiffusion(); // to express it in mm/sqrt(cm)
}

TCanvas* c = new TCanvas("Transitudinal diffusion", " ");
TGraph* fTransDiff = new TGraph(nSteps, &eField[0], &transDiff[0]);
auto c = new TCanvas("Transitudinal diffusion", " ");
auto fTransDiff = new TGraph(nSteps, &eField[0], &transDiff[0]);
TString str;
str.Form("Transversal diffusion for %s (Pressure: %3.1lf bar)", GetName(), this->GetPressure());
fTransDiff->SetTitle(str);
Expand Down Expand Up @@ -1015,8 +1068,8 @@ void TRestDetectorGas::PlotTownsendCoefficient(Double_t eMin, Double_t eMax, Int
townsendCoeff[i] = GetTownsendCoefficient(eField[i]);
}

TCanvas* c = new TCanvas("Townsend coefficient", " ");
TGraph* fTownsend = new TGraph(nSteps, &eField[0], &townsendCoeff[0]);
auto c = new TCanvas("Townsend coefficient", " ");
auto fTownsend = new TGraph(nSteps, &eField[0], &townsendCoeff[0]);
TString str;
str.Form("Townsend coefficient for %s", GetName());
fTownsend->SetTitle(str);
Expand Down

0 comments on commit 985cd11

Please sign in to comment.