List_Equations_Scalaires_Passifs_Especes.h

/****************************************************************************
* Copyright (c) 2024, 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 List_Equations_Scalaires_Passifs_Especes_included
#define List_Equations_Scalaires_Passifs_Especes_included
 
#include <Equation_base.h>
#include <TRUST_Deriv.h>
#include <TRUST_List.h>
#include <TRUST_Ref.h>
 
class Milieu_base;
 
/*! @brief List_Equations_Scalaires_Passifs_Especes Represents a list of passive scalar or species equations
 *
 *      List_Equations_Scalaires_Passifs_Especes contains a list of equations
 *      for passive scalars or species and is seen as a single equation
 *      it holds a real list of equations
 *
 */
 
class List_Equations_Scalaires_Passifs_Especes : public Equation_base
{
  Declare_instanciable(List_Equations_Scalaires_Passifs_Especes);
public :
  const Equation_base& equation(int i) const { return list_eq(i).valeur(); }
  int nb_equation() { return list_eq.size(); }
  int nb_equation() const { return list_eq.size(); }
  int complete() { return complet; }
  int complete() const { return complet; }
  void discretiser() override { }
  void associer_milieu_equation() override;
  void associer_milieu_base(const Milieu_base& mil1) override { mil=mil1; }
  const Milieu_base& milieu() const override { return mil.valeur(); }
  Milieu_base& milieu() override { return mil.valeur(); }
  int nombre_d_operateurs() const override { return 0; }
 
  Equation_base& equation(int i)
  {
    if (nb_equation()==0)
      {
        Cerr << "\nError in List_Equations_Scalaires_Passifs_Especes::equation() : The equation list is empty !" << finl;
        Process::exit();
      }
    return list_eq(i).valeur();
  }
 
  const Operateur& operateur(int) const override { throw; }
  Operateur& operateur(int) override { throw; }
 
  const Champ_Inc_base& inconnue() const override { throw; }
  Champ_Inc_base& inconnue() override { throw; }
 
protected :
  LIST(OWN_PTR(Equation_base)) list_eq;
  OBS_PTR(Milieu_base) mil;
  int complet = 0;
};
 
#endif /* List_Equations_Scalaires_Passifs_Especes_included */