Field_base.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 Field_base_included
#define Field_base_included
 
#include <Objet_U.h>
#include <Noms.h>
 
/*! @brief This is a base class from which inherit Champ_base and Champ_front_base.
 *
 * It handles all the generic aspect of a field:
 *      - its name and synonyms
 *      - its number and names of components
 *      - its nature (scalar, quadrature_scalaire, vectorial, quadrature_vectoriel,multi_scalaire, basis_function_scalar, basis_function_vectorial)
 *      - the units associated to each component
 *
 *
 * @sa RefField_base
 */
 
// Definition of the nature of a field:
enum Nature_du_champ { scalaire, quadrature_scalaire, multi_scalaire, vectoriel, quadrature_vectoriel,
                       basis_function_order_1_scalar, basis_function_order_2_scalar,
                       basis_function_order_1_vectorial, basis_function_order_2_vectorial
                     };
 
class Field_base : public Objet_U
{
  Declare_base_sans_constructeur(Field_base);
public:
  Field_base();
  Field_base(const Field_base& other) = default;
 
  // Methods reimplemented from Objet_U
  void nommer(const Nom&) override;
  const Nom& le_nom() const override;
 
  // Synonyms management
  inline const Noms& get_synonyms() const { return noms_synonymes_; }
  inline virtual void add_synonymous(const Nom& nom) { noms_synonymes_.add(nom); }
 
  // Component management
  virtual int nb_comp() const { return nb_compo_ ; } // Returns the number of components of the field.
  virtual void fixer_nb_comp(int i);
  virtual int nb_vect_comp() const;
 
  const Noms& noms_compo() const;
  const Nom& nom_compo(int) const;
  const Nom& nom_compo() const;
 
  virtual const Noms& fixer_noms_compo(const Noms&);
  virtual const Nom& fixer_nom_compo(int, const Nom&);
  virtual const Nom& fixer_nom_compo(const Nom&);
 
  // Physical unit management
  const Noms& unites() const;
  const Nom& unite() const;
  const Nom& unite(int) const;
  virtual const Noms& fixer_unites(const Noms&);
  virtual const Nom& fixer_unite(const Nom&);
  virtual const Nom& fixer_unite(int i, const Nom&);
 
  // Field nature management
  virtual Nature_du_champ nature_du_champ() const { return nature_; } // Returns the nature of a field (scalar, multiscalar, vectorial).
  virtual Nature_du_champ fixer_nature_du_champ(Nature_du_champ nat);
 
  bool is_basis_function() const  { return nature_ >= basis_function_order_1_scalar; }
  bool is_quadrature() const  { return nature_ == quadrature_scalaire or nature_ == quadrature_vectoriel; }
  bool is_vectorial() const
  {
    return nature_==vectoriel or nature_==quadrature_vectoriel or nature_ == basis_function_order_1_vectorial or nature_ == basis_function_order_2_vectorial;
  }
  bool is_scalar() const
  {
    return nature_==scalaire or nature_==quadrature_scalaire;
  }
  int order_field() const;
 
protected:
  Nom nom_;
  Noms noms_synonymes_, noms_compo_, unite_;
  int nb_compo_;
  Nature_du_champ nature_;
};
 
#endif /* Field_base_included */