TrioCFD 1.9.9_beta
TrioCFD documentation
Loading...
Searching...
No Matches
Champ_Generique_Moyenne.h
1/****************************************************************************
2* Copyright (c) 2026, 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
17#ifndef Champ_Generique_Moyenne_included
18#define Champ_Generique_Moyenne_included
19
20#include <Champ_Generique_Statistiques_base.h>
21#include <TRUSTTabs_forward.h>
22#include <Op_Moyenne.h>
23
25
26/*! @brief class Champ_Generique_Moyenne OWN_PTR(Champ_base) intended to post-process an average of a generic field
27 *
28 * The class carries a statistical operator "Op_Moyenne"
29 *
30 */
31
32//// Data file syntax to follow
33//
34// "field_name" Moyenne { t_deb "val_tdeb" t_fin "val_tfin"
35// source "generic_field_type" { ...source ref_Champ { Pb_champ "pb_name" "discrete_field_name" } }
36// }
37// "field_name" set by the user will be the name of the generic field
38// "val_tdeb" and "val_tfin" value of the start and end of statistics for this field
39// "generic_field_type" type of a generic field
40
42{
43 Declare_instanciable(Champ_Generique_Moyenne);
44
45public:
46
47 void set_param(Param& param) const override;
48 int lire_motcle_non_standard(const Motcle&, Entree&) override;
49 const Noms get_property(const Motcle& query) const override;
50
51 inline double temps() const override
52 {
53 return Op_Moyenne_.integrale().le_champ_calcule().temps();
54 };
55 inline const Integrale_tps_Champ& integrale() const override
56 {
57 return Op_Moyenne_.integrale();
58 };
59
60 inline const Operateur_Statistique_tps_base& Operateur_Statistique() const override;
62 void completer(const Postraitement_base& post) override;
63 const Champ_base& get_champ_without_evaluation(OWN_PTR(Champ_base)& espace_stockage) const override;
64 const Champ_base& get_champ(OWN_PTR(Champ_base)& espace_stockage) const override;
65 void nommer_source() override;
66
67 const Champ_Generique_base& get_champ_post(const Motcle& nom) const override;
68 bool has_champ_post(const Motcle& nom) const override;
69 int comprend_champ_post(const Motcle& identifiant) const override;
70
71protected:
72
74
75private:
76 mutable OWN_PTR(Champ_Fonc_base) espace_stockage_;
77};
78
79
84
89#endif
90
class Champ_Fonc_base Base class of fields that are functions of a calculated quantity
class Champ_Generique_Moyenne OWN_PTR(Champ_base) intended to post-process an average of a generic fi...
const Champ_base & get_champ(OWN_PTR(Champ_base)&espace_stockage) const override
const Noms get_property(const Motcle &query) const override
Returns the requested property.
void set_param(Param &param) const override
int comprend_champ_post(const Motcle &identifiant) const override
int lire_motcle_non_standard(const Motcle &, Entree &) override
Reads non-simple-type parameters of an Objet_U from an input stream.
void completer(const Postraitement_base &post) override
double temps() const override
const Integrale_tps_Champ & integrale() const override
const Operateur_Statistique_tps_base & Operateur_Statistique() const override
bool has_champ_post(const Motcle &nom) const override
const Champ_base & get_champ_without_evaluation(OWN_PTR(Champ_base)&espace_stockage) const override
const Champ_Generique_base & get_champ_post(const Motcle &nom) const override
class Champ_Generique_base
class Champ_base This class is the base of the fields hierarchy.
Definition Champ_base.h:43
Class defining operators and methods for all reading operation in an input flow (file,...
Definition Entree.h:42
A character string (Nom) in uppercase.
Definition Motcle.h:26
An array of character strings (VECT(Nom)).
Definition Noms.h:26
class Operateur_Statistique_tps_base
Helper class to factorize the readOn method of Objet_U classes.
Definition Param.h:112
Base class for all post-processing objects.