From 3fffec689286a77c4dd634c30d930f4edef3c525 Mon Sep 17 00:00:00 2001
From: Van Dung NGUYEN <vdg.nguyen@gmail.com>
Date: Fri, 14 Apr 2023 10:17:23 +0200
Subject: [PATCH] update instructions

---
 .../nlsolver/nonLinearMechSolver.cpp          | 21 +++++++++++++------
 1 file changed, 15 insertions(+), 6 deletions(-)

diff --git a/NonLinearSolver/nlsolver/nonLinearMechSolver.cpp b/NonLinearSolver/nlsolver/nonLinearMechSolver.cpp
index 45ffe7235..9bca682e9 100644
--- a/NonLinearSolver/nlsolver/nonLinearMechSolver.cpp
+++ b/NonLinearSolver/nlsolver/nonLinearMechSolver.cpp
@@ -8333,10 +8333,11 @@ void nonLinearMechSolver::archivingNodeIPOnPhysicalGroup(const int dim, const in
 };
 
 /**
- * @brief Arching a value IP on an interface element
+ * @brief Archiving a value IP on an interface element. The result is stored under a csv file.
  * @param elenumMinus, elenumPlus: interface between two bulk elements
- * @param ipval: a quantity specified IPField::Ouput
- * @param elemval: operation to perform: 1 - mean value, 2 - min value, 3 - max value, otherwise - value at a specific Gausspoint specifyied by numip
+ * @param ipval: a quantity specified in IPField::Ouput
+ * @param elemval: an operation to perform: 1 - mean value, 2 - min value, 3 - max value, and aribtrary another value - value at a specific Gausspoint specifyied by numip
+ * @param elemval: an operation to perform: 1 - mean value, 2 - min value, 3 - max value, and aribtrary another value - value at a specific Gausspoint specifyied by numip
  * @param numip (0 by default): specifying a IP to archive, ranging from 0 to npts-1. This optiton is considered if elemval is not 1, 2, or 3
  * @param nstep (1 by default): archiving frequence after each nstep time steps
  */
@@ -8346,10 +8347,10 @@ void nonLinearMechSolver::archivingInterfaceElementIP(const int elenumMinus,cons
 
 
 /**
- * @brief Arching a value IP on an bulk element
+ * @brief Archiving a value IP on a bulk element. . The result is stored under a csv file.
  * @param elenum: element number
- * @param ipval: a quantity specified IPField::Ouput
- * @param elemval: operation to perform: 1 - mean value, 2 - min value, 3 - max value, otherwise - the value at a specific Gausspoint specifyied by numip
+ * @param ipval: a quantity specified in IPField::Ouput
+ * @param elemval: an operation to perform between 1 - mean value, 2 - min value, 3 - max value, and aribtrary another value - the value at a specific Gausspoint specifyied by numip
  * @param numip (0 by default): specifying a IP to archive, ranging from 0 to npts-1. This optiton is considered if elemval is not 1, 2, or 3
  * @param nstep (1 by default): archiving frequence after each nstep time steps
  */
@@ -8358,6 +8359,14 @@ void nonLinearMechSolver::archivingElementIP(const int elenum,const int ipval,co
   vaip.push_back(IPField::ip2archive(-1, elenum, elenum,ipval,elemval,nstep,numip));
 };
 
+/**
+ * @brief Archiving a value on a physical (only mean, min, max over this physical are available).
+ * @param onwhat: entity identification between Node, Edge, Face, or Volume
+ * @param numphys: physical number of the entity
+ * @param ipval: a quantity specified in IPField::Ouput
+ * @param elemval: an operation to perform between 1 - mean value, 2 - min value, 3 - max value
+ * @param nstep (1 by default): archiving frequence after each nstep time steps
+ */
 void nonLinearMechSolver::archivingIPOnPhysicalGroup(std::string onwhat, const int numphys, const int ipval,const int elemval, const int nstep){
 
   const std::string node("Node");
-- 
GitLab