Sonde_Int.h

/****************************************************************************
* Copyright (c) 2024, CEA
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
* 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
* 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
* IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
* OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
*****************************************************************************/
 
#ifndef Sonde_Int_included
#define Sonde_Int_included
 
#include <TRUST_Ref.h>
#include <SFichier.h>
#include <TRUSTTab.h>
 
class Postraitement;
#include <Domaine_forward.h>
 
/*! @brief class Sonde_Int
 * @brief Allows tracking the evolution of an integer array over time.
 *
 *      A set of points at which the array is to be probed is chosen,
 *      along with the observation period. Postraitement objects hold probes
 *      for the fields to monitor; each probe in turn holds a reference to
 *      its post-processing object.
 *
 * @sa Postraitement Sonde_Ints
 */
class Sonde_Int : public Objet_U
{
  Declare_instanciable_sans_destructeur(Sonde_Int);
 
public :
 
  inline Sonde_Int(const Nom& );
  void associer_post(const Postraitement& );
  void initialiser(const Domaine& );
  void mettre_a_jour(double temps, double tinit);
  void postraiter(double );
  void ouvrir_fichier();
  inline void fermer_fichier();
  inline const IntVect& le_tableau() const;
  inline const DoubleTab& les_positions() const;
  inline const IntVect& les_poly() const;
  inline void fixer_periode(double);
  inline double temps() const;
  //int add(const DoubleTab&);
  //int add(const double, const double);
  //int add(const double, const double, const double);
  inline SFichier& fichier();
  inline ~Sonde_Int() override;
 
private :
 
  OBS_PTR(Postraitement) mon_post;
  Nom nom_;                                // probe name
  int dim = -1;                                // dimension of the probe (point:0, segment:1, plan:2, volume:3)
  int nbre_points1= -1,nbre_points2= -1,nbre_points3= -1;        // for segment, plan, etc. probes
  OBS_PTR(IntVect) mon_tableau;                // the probed array
  DoubleTab les_positions_;                // coordinates of point probes
  IntVect elem_;                        // elements containing the point probes
  IntTab valeurs;                      // values of mon_tableau at indices given by elem_
  double periode= 1.e10;                        // sampling period
  double nb_bip= 0.;
  SFichier* le_fichier;
};
 
 
/*! @brief Constructor for a probe given its name.
 *
 * @param nom the name of the probe to construct
 */
inline Sonde_Int::Sonde_Int(const Nom& nom)
  : nom_(nom), le_fichier(0)
{}
 
 
 
/*! @brief Returns the elapsed time.
 *
 * @return the elapsed time
 */
inline double Sonde_Int::temps() const
{
  return nb_bip*periode;
}
 
 
 
/*! @brief Closes the file to which the probe writes.
 *
 */
inline void Sonde_Int::fermer_fichier()
{
  if (le_fichier)
    {
      delete le_fichier;
    }
}
 
 
/*! @brief Sets the sampling period for probing the field.
 *
 * @param pe the sampling period
 */
inline void Sonde_Int::fixer_periode(double pe)
{
  periode=pe;
}
 
 
/*! @brief Returns the associated array.
 *
 * @return the associated integer array
 */
inline const IntVect& Sonde_Int::le_tableau() const
{
  return mon_tableau.valeur();
}
 
 
/*! @brief Returns the array of probed positions.
 *
 * @return the probed positions
 */
inline const DoubleTab& Sonde_Int::les_positions() const
{
  return les_positions_;
}
 
 
/*! @brief Returns the array of elements being probed.
 *
 * @return the elements being probed
 */
inline const IntVect& Sonde_Int::les_poly() const
{
  return elem_;
}
 
 
/*! @brief Returns the output file stream used by the probe.
 *
 * @return the output file stream used by the probe
 */
inline SFichier& Sonde_Int::fichier()
{
  return *le_fichier;
}
 
/*! @brief Destructor.
 *
 * Closes the file before destroying the object.
 *
 */
inline Sonde_Int::~Sonde_Int()
{
  fermer_fichier();
}
 
 
#endif