Format_Post_CGNS.h

/****************************************************************************
* Copyright (c) 2026, 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 Format_Post_CGNS_included
#define Format_Post_CGNS_included
 
#include <Format_Post_base.h>
#include <Ecrire_CGNS.h>
 
/*! @brief class Format_Post_CGNS
 *
 *  The CFD General Notation System (CGNS) provides a general, portable, and extensible standard for the storage and
 *  retrieval of computational fluid dynamics (CFD) analysis data. It consists of a collection of conventions,
 *  and free and open software implementing those conventions. It is self-descriptive, machine-independent, well-documented,
 *  and administered by an international steering committee.
 *
 *  It is also an American Institute of Aeronautics and Astronautics (AIAA) Recommended Practice.
 *  The system consists of two parts: (1) a standard data model and mapping format for recording the data,
 *  and (2) software that reads, writes, and modifies data in that format. The format is a conceptual entity established by
 *  the documentation; the software is a physical product supplied to enable developers to access and produce data recorded
 *  in that format.
 *
 *  The CGNS system is designed to facilitate the exchange of data between sites and applications, and to help stabilize
 *  the archiving of aerodynamic data. The data are stored in a compact, binary format and are accessible through a complete and
 *  extensible library of functions.
 *  The API (Application Program Interface) is platform independent and can be easily implemented in C, C++, Fortran and
 *  Fortran90 applications.
 *
 *   CGNS is self-describing, allowing an application to interpret the structure and contents of a file without any outside information.
 *   CGNS can make use of either two different low-level data formats:
 *
 *      - an internally developed and supported method called Advanced Data Format (ADF),
 *        based on a common file format system previously in use at McDonnell Douglas,
 *
 *
 *      - HDF5, a widely used hierarchical data format
 *
 *  see : https://cgns.github.io/cgns-modern.github.io/index.html
 *        https://en.wikipedia.org/wiki/CGNS
 *
 */
 
class Format_Post_CGNS : public Format_Post_base
{
  Declare_instanciable_sans_constructeur(Format_Post_CGNS);
public:
  Format_Post_CGNS();
 
  void reset() override;
  void set_param(Param& param) const override;
  void set_postraiter_domain() override;
  void set_deformable_domain() override;
  void set_lagrangian_domain() override;
  void set_discr_type(const Nom&) override;
  void set_loc_vector(const std::vector<std::string>&) override;
  void resetTime(double t, const std::string dirname) override;
  int initialize_by_default(const Nom&) override;
  int initialize(const Nom&, const int, const Nom&) override;
 
  int completer_post(const Domaine&, const int, const Nature_du_champ&, const int, const Noms&, const Motcle&, const Nom&) override { return 1; }
  int preparer_post(const Nom&, const int, const int, const double) override { return 1; }
 
  int ecrire_entete(const double, const int, const int) override;
  int ecrire_temps(const double) override;
  int finir(const int) override;
  int finir_ecriture(double) override;
 
  void ecrire_domaine_dual(const Domaine& , const int ) override;
  int ecrire_domaine_dis(const Domaine& ,const OBS_PTR(Domaine_dis_base)& ,const int ) override;
  int ecrire_domaine(const Domaine&, const int) override;
  int ecrire_domaine_low_level(const Domaine * ,const Nom& , const DoubleTab& , const IntTab& , const Motcle& );
  int ecrire_item_int(const Nom&, const Nom&, const Nom&, const Nom&, const Nom&, const IntVect&, const int) override { return 1; }
  int ecrire_champ(const Domaine&, const Noms&, const Noms&, int, double, const Nom&, const Nom&, const Nom&, const Nom&, const DoubleTab&) override;
 
#ifdef HAS_CGNS
  // for convenience
  inline Ecrire_CGNS& get_cgns_writer() { return cgns_writer_; }
  inline const Ecrire_CGNS& get_cgns_writer() const { return cgns_writer_; }
#endif
 
private:
  Nom cgns_basename_;
#ifdef HAS_CGNS
  Ecrire_CGNS cgns_writer_;
#endif
};
 
#endif /* Format_Post_CGNS_included */