Option_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 Option_CGNS_included
#define Option_CGNS_included
 
#include <Interprete.h>
 
class Motcle;
 
/**
 * @brief Global CGNS post-processing options.
 *
 * This interpreter configures the file layout used by `Ecrire_CGNS`.
 * The options intentionally describe families of workflows rather than low-level CGNS calls.
 *
 * Main families:
 * - single file: one CGNS file stores all written times and fields,
 * - linked files: one mesh file, one solution file per post time, and one
 *   final link file used as the visualization entry point,
 * - communicator-group output: the same two strategies, but replicated on
 *   user-defined MPI communicator groups.
 *
 * Compatibility rules:
 * - `PARALLEL_OVER_ZONE` and `SINGLE_FILE_PER_COMM_GROUP` belong to the single-file family,
 * - `USE_LINKS` and `LINKED_FILES_PER_COMM_GROUP` belong to the linked-file family,
 * - mixing both families is rejected explicitly.
 */
class Option_CGNS: public Interprete
{
  Declare_instanciable(Option_CGNS);
public:
  Entree& interpreter(Entree&) override;
 
  /* Single file options : NOT BY DEFAULT */
  static bool PARALLEL_OVER_ZONE, SINGLE_FILE_PER_COMM_GROUP;
  static int CLOSE_EVERY_N, FLUSH_EVERY_N;
 
  /* Multiple linked files options : NOT BY DEFAULT */
  static bool USE_LINKS, LINKED_FILES_PER_COMM_GROUP;
 
  /* Keep old cgns files if resetTime is used ... */
  static bool KEEP_FILES_BEFORE_RESET_TIME;
};
 
#endif /* Option_CGNS_included */