Add Doxygen documentation and include updates for CUDAProb3 and ProbGPU

dbarrow257 · Oct 7, 2024 · 2d1b019 · 2d1b019
1 parent b7af34a
commit 2d1b019
Show file tree

Hide file tree

Showing 8 changed files with 50 additions and 18 deletions.
diff --git a/OscProbCalcer/OscProbCalcerFactory.h b/OscProbCalcer/OscProbCalcerFactory.h
@@ -26,12 +26,19 @@ class OscProbCalcerFactory {
   /**
    * @brief Create an instance of OscProbCalcerBase::OscProbCalcerBase() objects from a YAML config. 
    *
-   * @param ConfigName_ Path to YAML config file
+   * @param OscProbCalcerConfigName_ Path to YAML config file
    *
-   * @return OscillatorBase::OscillatorBase() object
+   * @return Intialised OscProbCalcerBase::OscProbCalcerBase() object
    */
   OscProbCalcerBase* CreateOscProbCalcer(std::string OscProbCalcerConfigName_);
 
+  /**
+   * @brief Create an instance of OscProbCalcerBase::OscProbCalcerBase() objects from a YAML Node
+   *
+   * @param OscProbCalcerConfig Instance of YAML node
+   *
+   * @return Intialised OscProbCalcerBase::OscProbCalcerBase() object
+   */
   OscProbCalcerBase* CreateOscProbCalcer(YAML::Node OscProbCalcerConfig);
 
  protected:

diff --git a/OscProbCalcer/OscProbCalcer_CUDAProb3.cpp b/OscProbCalcer/OscProbCalcer_CUDAProb3.cpp
@@ -13,7 +13,7 @@
 #include <iostream>
 using namespace cudaprob3;
 
-OscProbCalcerCUDAProb3::OscProbCalcerCUDAProb3(std::string ConfigName_, int Instance_) : OscProbCalcerBase(ConfigName_,"CUDAProb3",Instance_)
+OscProbCalcerCUDAProb3::OscProbCalcerCUDAProb3(YAML::Node Config_) : OscProbCalcerBase(Config_)
 {
   //=======
   //Grab information from the config

diff --git a/OscProbCalcer/OscProbCalcer_CUDAProb3.h b/OscProbCalcer/OscProbCalcer_CUDAProb3.h
@@ -21,13 +21,19 @@ namespace cudaprob3 { template<typename T> class Propagator;}
  */
 class OscProbCalcerCUDAProb3 : public OscProbCalcerBase {
  public:
-    /**
+  /**
    * @brief Default constructor
    *
-   * @param ConfigName_ Name of config used to setup the OscProbCalcerCUDAProb3() instance
-   * @param Instance_ Which entry of the OscProbCalcerSetup config block should be read in the case where there are multiple OscProbCalcers to be initialised
+   * @param Config_ YAML::Node to setup the OscProbCalcerNuCUDAProb3() instance
    */
-  OscProbCalcerCUDAProb3(std::string ConfigName_="", int Instance_=0);
+  OscProbCalcerCUDAProb3(YAML::Node Config_);
+
+  /**
+   * @brief Constructor which takes a file path, creates a YAML::Node and calls the default constructor
+   *
+   * @param ConfigName_ File path to config
+   */  
+  OscProbCalcerCUDAProb3(std::string ConfigName_) : OscProbCalcerNuFASTLinear(YAML::LoadFile(ConfigName_)) {}
 
   /**
    * @brief Destructor

diff --git a/OscProbCalcer/OscProbCalcer_CUDAProb3Linear.h b/OscProbCalcer/OscProbCalcer_CUDAProb3Linear.h
@@ -22,14 +22,18 @@ namespace cudaprob3 { template<typename T> class Propagator;}
  */
 class OscProbCalcerCUDAProb3Linear : public OscProbCalcerBase {
  public:
-    /**
+  /**
    * @brief Default constructor
    *
-   * @param ConfigName_ Name of config used to setup the OscProbCalcerCUDAProb3Linear() instance
-   * @param Instance_ Which entry of the OscProbCalcerSetup config block should be read in the case where there are multiple OscProbCalcers to be initialised
+   * @param Config_ YAML::Node to setup the OscProbCalcerCUDAProb3Linear() instance
    */
   OscProbCalcerCUDAProb3Linear(YAML::Node Config_);
 
+  /**
+   * @brief Constructor which takes a file path, creates a YAML::Node and calls the default constructor
+   *
+   * @param ConfigName_ File path to config
+   */
   OscProbCalcerCUDAProb3Linear(std::string ConfigName_) : OscProbCalcerCUDAProb3Linear(YAML::LoadFile(ConfigName_)) {}
 
   /**

diff --git a/OscProbCalcer/OscProbCalcer_NuFASTLinear.h b/OscProbCalcer/OscProbCalcer_NuFASTLinear.h
@@ -16,11 +16,15 @@ class OscProbCalcerNuFASTLinear : public OscProbCalcerBase {
   /**
    * @brief Default constructor
    *
-   * @param ConfigName_ Name of config used to setup the OscProbCalcerNuFASTLinear() instance
-   * @param Instance_ Which entry of the OscProbCalcerSetup config block should be read in the case where there are multiple OscProbCalcers to be initialised
+   * @param Config_ YAML::Node to setup the OscProbCalcerNuFASTLinear() instance
    */
   OscProbCalcerNuFASTLinear(YAML::Node Config_);
 
+  /**
+   * @brief Constructor which takes a file path, creates a YAML::Node and calls the default constructor
+   *
+   * @param ConfigName_ File path to config
+   */
   OscProbCalcerNuFASTLinear(std::string ConfigName_) : OscProbCalcerNuFASTLinear(YAML::LoadFile(ConfigName_)) {}
 
   /**

diff --git a/OscProbCalcer/OscProbCalcer_Prob3ppLinear.h b/OscProbCalcer/OscProbCalcer_Prob3ppLinear.h
@@ -18,11 +18,15 @@ class OscProbCalcerProb3ppLinear : public OscProbCalcerBase {
   /**
    * @brief Default constructor
    *
-   * @param ConfigName_ Name of config used to setup the OscProbCalcerProb3ppLinear() instance
-   * @param Instance_ Which entry of the OscProbCalcerSetup config block should be read in the case where there are multiple OscProbCalcers to be initialised
+   * @param Config_ YAML::Node to setup the OscProbCalcerProb3ppLinear() instance
    */
   OscProbCalcerProb3ppLinear(YAML::Node Config_);
 
+  /**
+   * @brief Constructor which takes a file path, creates a YAML::Node and then calls default constructor
+   *
+   * @param ConfigName_ Path to config file
+   */
   OscProbCalcerProb3ppLinear(std::string ConfigName_) : OscProbCalcerProb3ppLinear(YAML::LoadFile(ConfigName_)) {}
 
   /**

diff --git a/OscProbCalcer/OscProbCalcer_ProbGPULinear.cpp b/OscProbCalcer/OscProbCalcer_ProbGPULinear.cpp
@@ -5,7 +5,7 @@ extern "C" void GetProb(int Alpha, int Beta, double Path, double Density, double
 
 #include <iostream>
 
-OscProbCalcerProbGPULinear::OscProbCalcerProbGPULinear(std::string ConfigName_, int Instance_) : OscProbCalcerBase(ConfigName_,"ProbGPULinear",Instance_)
+OscProbCalcerProbGPULinear::OscProbCalcerProbGPULinear(YAML::Node Config_) : OscProbCalcerBase(Config_)
 {
   //=======
   //Grab information from the config

diff --git a/OscProbCalcer/OscProbCalcer_ProbGPULinear.h b/OscProbCalcer/OscProbCalcer_ProbGPULinear.h
@@ -16,10 +16,17 @@ class OscProbCalcerProbGPULinear : public OscProbCalcerBase {
   /**
    * @brief Default constructor
    *
-   * @param ConfigName_ Name of config used to setup the OscProbCalcerProbGPULinear() instance
-   * @param Instance_ Which entry of the OscProbCalcerSetup config block should be read in the case where there are multiple OscProbCalcers to be initialised
+   * @param Config_ YAML::Node to setup the OscProbCalcerProbGPULinear() instance
    */
-  OscProbCalcerProbGPULinear(std::string ConfigName_="", int Instance_=0);
+  OscProbCalcerProbGPULinear(YAML::Node Config_);
+
+
+  /**
+   * @brief Constructor which takes a file path, creates a YAML::Node and calls the default constructor
+   *
+   * @param ConfigName_ File path to config
+   */  
+  OscProbCalcerProbGPULinear(std::string ConfigName_) : OscProbCalcerProbGPULinear(YAML::LoadFile(ConfigName_)) {}
 
   /**
    * @brief Destructor