TrioCFD 1.9.9_beta
TrioCFD documentation
Loading...
Searching...
No Matches
Source.h
1/****************************************************************************
2* Copyright (c) 2024, CEA
3* All rights reserved.
4*
5* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
6* 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
7* 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.
8* 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.
9*
10* 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.
11* 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;
12* 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.
13*
14*****************************************************************************/
15
16#ifndef Source_included
17#define Source_included
18
19#include <Source_base.h>
20#include <TRUST_Deriv.h>
21
22class Equation_base;
23
24/*! @brief Source Generic class of the source term hierarchy. A Source object can
25 *
26 * reference any object derived from Source_base.
27 * Most methods call the methods of the underlying Problem
28 * object via the valeur() method declared through the macro
29 *
30 * @sa Source_base
31 */
32class Source : public OWN_PTR(Source_base)
33{
34 Declare_instanciable(Source);
35public :
36 DoubleTab& ajouter(DoubleTab& ) const;
37 DoubleTab& calculer(DoubleTab& ) const;
38
39 void typer_direct(const Nom& );
40 void typer(const Nom&, const Equation_base&);
41};
42#endif
class Equation_base The role of an equation is the calculation of one or more fields....
class Nom: a character string for naming TRUST objects.
Definition Nom.h:31
Source Generic class of the source term hierarchy. A Source object can.
Definition Source.h:33
DoubleTab & ajouter(DoubleTab &) const
Call to the underlying object.
Definition Source.cpp:73
DoubleTab & calculer(DoubleTab &) const
Call to the underlying object.
Definition Source.cpp:88
void typer(const Nom &, const Equation_base &)
Types the source by computing the required type name from the provided parameters.
Definition Source.cpp:52
void typer_direct(const Nom &)
Definition Source.cpp:41