Champ_Generique_Morceau_Equation.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 Champ_Generique_Morceau_Equation_included
#define Champ_Generique_Morceau_Equation_included
 
#include <Champ_Gen_de_Champs_Gen.h>
#include <TRUST_Ref.h>
 
class Equation_base;
class MorEqn;
 
/*! @brief class Champ_Generique_Morceau_Equation OWN_PTR(Champ_base) intended to post-process a quantity related to an equation piece
 *
 *  See the MorEqn hierarchy to know the available equation pieces
 *  Syntax to follow in the data file
 *
 *  "field_name" Morceau_Equation { type "type_moreqn" numero "numero_moreqn" option "type_option" [ compo "num_compo" ]
 *                                                 source Champ_Post_ref_Champ { Pb_champ "pb_name" "discrete_field_name" }
 *                }
 *  "field_name"     set by the user will be the name of the generic field
 *  "unite"     set by the user for readability in post-processing
 *  "type_moreqn"   designates the type of equation piece (currently available: "operateur")
 *  "numero_moreqn" designates the piece number
 *                    ex: operator case: 0 (diffusion) 1 (convection) 2 (gradient) 3 (divergence)
 *  "type_option"   chosen option ("stabilite" or "flux_bords")
 *  "num_compo"           component number to post-process (to consider only for "flux_bords" if multiple components)
 *
 */
 
class Champ_Generique_Morceau_Equation : public Champ_Gen_de_Champs_Gen
{
 
  Declare_instanciable(Champ_Generique_Morceau_Equation);
 
public:
 
 
  void set_param(Param& param) const override;
  const Noms get_property(const Motcle& query) const override;
  Entity  get_localisation(const int index = -1) const override;
  const   Motcle             get_directive_pour_discr() const override;
  const Champ_base&  get_champ(OWN_PTR(Champ_base)& espace_stockage) const override;
  const Champ_base&  get_champ_without_evaluation(OWN_PTR(Champ_base)& espace_stockage) const override;
 
  OWN_PTR(Champ_Fonc_base)& creer_espace_stockage(const Nature_du_champ& nature,
                                                  const int nb_comp,
                                                  OWN_PTR(Champ_Fonc_base)& es_tmp) const override;
  const MorEqn& morceau() const;
  MorEqn& morceau();
  void completer(const Postraitement_base& post) override;
  void nommer_source() override;
 
protected:
 
  int numero_morceau_=-1;              //numero du morceau d equation
  Nom type_morceau_;                //type du morceau d equation (ex : Operateur)
  Nom option_;                      //Pour selectionner la quantite a postraiter
  int compo_=0;                            //Pour identifier la composante a recuperer pour l option flux_bords
  OBS_PTR(Equation_base) ref_eq_;       //REF vers l equation qui porte le morceau
  Motcle  localisation_;            //localisation correspondant au support du champ postraite
  Nom unite_;                 //unite du champ obtenu (a specifier par l'utilisateur)
 
 
};
 
#endif