Constituant.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 Constituant_included
#define Constituant_included
 
#include <Milieu_base.h>
 
/*! @brief Represents the constituent(s) of a fluid.
 *
 *  @brief Contains a field alpha representing the diffusion coefficient of the constituent.
 *     When a Constituant object represents multiple constituents, the field alpha is vectorial
 *     with as many components as there are constituents.
 *
 * @sa Milieu_base
 */
class Constituant : public Milieu_base
{
  Declare_instanciable(Constituant);
public :
 
  void set_param(Param& param) const override;
 
  inline const Champ_Don_base& diffusivite_constituant() const
  {
    assert(D_);
    return D_.valeur();
  }
 
  inline void mettre_a_jour(double temps) override
  {
    if (D_) D_->mettre_a_jour(temps);
  }
 
  void discretiser(const Probleme_base& pb, const Discretisation_base& dis) override;
 
  void discretiser_multi_concentration(const Nom& , const Probleme_base& pb, const Discretisation_base& dis);
 
  int initialiser(const double temps) override
  {
    if (D_) D_->initialiser(temps);
    return 1;
  }
 
  inline int nb_constituants() const
  {
    return diffusion_multi_scalaire_ ? static_cast<int>(std::sqrt(D_->nb_comp())) /* TODO FIXME */ : D_->nb_comp();
  }
  int lire_motcle_non_standard(const Motcle& mot, Entree& is) override;
 
protected :
  OWN_PTR(Champ_Don_base) D_; // Diffusion coefficient of the constituent in a medium
  bool diffusion_multi_scalaire_ = false;
};
 
#endif /* Constituant_included */