documentation in state branch

inc/MPM.h

@@ -94,8 +94,12 @@ class MPM {
 	///
 	void end();
 
+	/// \brief Load model state
+	///
 	void loadState();
 
+	/// \brief Save model state
+	///
 	void saveState();
 private:
 

inc/Model.h

@@ -44,15 +44,22 @@ namespace ModelSetup {
 	/// \return True if is Linux system
 	bool getLinuxSystem();
 
+	/// \brief Return true is load state is activated
+	/// \return True is load state is activated
 	bool getLoadState();
 
+	/// \brief Set load state activated
+	/// \param[in] load_state_activated Flag to load an state
 	void setLoadState(bool st);
 
+	/// \brief Return true is save state is activated
+	/// \return True is save state is activated
 	bool getSaveState();
 
+	/// \brief Set save state activated
+	/// \param[in] save_state_activated Flag to save an state
 	void setSaveState(bool st);
 
-
 	/// \brief Return the number of nodes that a particle contributes
 	/// \return The number of nodes that a particle contributes
 	unsigned getContributionNodesNum();

inc/States.h

@@ -7,8 +7,14 @@
 
 namespace States {
 
+	/// \brief Save the particles stress into a json file
+	/// \param[in] filename File name
+	/// \param[in] particles List containing pointers to particles
 	void saveParticleStress(const std::string& filename, const std::vector<Particle*>& particles);
 
+	/// \brief Load the particles stress from a json file
+	/// \param[in] filename File name
+	/// \param[in] particles List containing pointers to particles
 	void loadParticleStress(const std::string& filename, std::vector<Particle*>& particles);
 }
 

src/Model.cpp

@@ -25,7 +25,7 @@ namespace ModelSetup {
 	// contact
 	bool contactActive=false; //!< is contact active
 
-	// state
+	// states
 	bool loadState = false; //!< if state need to be loaded
 	bool saveState = false; //!< if state need to be salved
 
@@ -53,15 +53,15 @@ namespace ModelSetup {
 	// time
 	double dt=0.0; //!< time step
 	double time=0.0; //!< simulation time
-	double dt_critical_multiplier=0.25; //!< dafault critical time step fraction
+	double dt_critical_multiplier = 0.25; //!< dafault critical time step fraction
 
 	// initial time simulation
     std::chrono::system_clock::time_point initialSimulationTime;
 
 	// default damping
 	DampingType damping=DampingType::UNDAMPED; //!< damping type
 
-	// default lodal damping value
+	// default local damping value
 	double localDamping=0.0; //!< local damping value
 
 	// input file
@@ -77,9 +77,9 @@ namespace ModelSetup {
 	/// Function members
 	///
 
+    // states 
 	bool getLoadState() { return loadState; }
 	void setLoadState(bool st) { loadState = st; }
-
 	bool getSaveState() { return saveState; }
 	void setSaveState(bool st) { saveState = st; }
 
@@ -92,8 +92,7 @@ namespace ModelSetup {
 
 	// results
 	unsigned getResultNum() { return resultNumber; }
-	void
-	setResultNum(unsigned d) { resultNumber=d; }
+	void setResultNum(unsigned d) { resultNumber=d; }
 	unsigned getResultSteps() { return static_cast<unsigned int>(floor(time/dt)/resultNumber); }
 
 	// time step
@@ -125,6 +124,7 @@ namespace ModelSetup {
 	bool getTwoPhaseActive() { return twoPhaseCalculationActive; }
 	void setTwoPhaseActive(bool d) { twoPhaseCalculationActive=d; }
 
+    // simulation time
     void setInitialSimulationTime(std::chrono::system_clock::time_point initialTime) { ModelSetup::initialSimulationTime = initialTime; }
     std::chrono::system_clock::time_point getInitialSimulationTime() { return ModelSetup::initialSimulationTime;  }
 
@@ -153,7 +153,8 @@ namespace ModelSetup {
 	// interpolation functions
 	ModelSetup::InterpolationFunctionType getInterpolationFunction() { return interpolationType; }
 	void setInterpolationFunction(ModelSetup::InterpolationFunctionType d) { interpolationType=d; }
-
+
+	// openMP threads
 	void setNumThreads(unsigned nThreads){
 
 		#ifdef _OPENMP