Arcane  4.1.12.0
User documentation
Loading...
Searching...
No Matches
IStandardFunction.h
1// -*- tab-width: 2; indent-tabs-mode: nil; coding: utf-8-with-signature -*-
2//-----------------------------------------------------------------------------
3// Copyright 2000-2026 CEA (www.cea.fr) IFPEN (www.ifpenergiesnouvelles.com)
4// See the top-level COPYRIGHT file for details.
5// SPDX-License-Identifier: Apache-2.0
6//-----------------------------------------------------------------------------
7/*---------------------------------------------------------------------------*/
8/* IStandardFunction.h (C) 2000-2025 */
9/* */
10/* Interface of a standard function. */
11/*---------------------------------------------------------------------------*/
12#ifndef ARCANE_CORE_ISTANDARDFUNCTION_H
13#define ARCANE_CORE_ISTANDARDFUNCTION_H
14/*---------------------------------------------------------------------------*/
15/*---------------------------------------------------------------------------*/
16
17#include "arcane/utils/IMathFunctor.h"
18
19/*---------------------------------------------------------------------------*/
20/*---------------------------------------------------------------------------*/
21
22namespace Arcane
23{
24
25/*---------------------------------------------------------------------------*/
26/*---------------------------------------------------------------------------*/
27
28/*!
29 * \brief Interface managing a standard function.
30 *
31 * These functions can be associated with a dataset option.
32 *
33 * Standard functions have the following possible prototypes:
34 * - f(Real,Real) -> Real
35 * - f(Real,Real3) -> Real
36 * - f(Real,Real) -> Real3
37 * - f(Real,Real3) -> Real3
38 *
39 */
40class ARCANE_CORE_EXPORT IStandardFunction
41{
42 public:
43
44 virtual ~IStandardFunction() = default;
45
46 public:
47
48 virtual IBinaryMathFunctor<Real, Real, Real>* getFunctorRealRealToReal() = 0;
49 virtual IBinaryMathFunctor<Real, Real3, Real>* getFunctorRealReal3ToReal() = 0;
50 virtual IBinaryMathFunctor<Real, Real, Real3>* getFunctorRealRealToReal3() = 0;
51 virtual IBinaryMathFunctor<Real, Real3, Real3>* getFunctorRealReal3ToReal3() = 0;
52};
53
54/*---------------------------------------------------------------------------*/
55/*---------------------------------------------------------------------------*/
56
57} // namespace Arcane
58
59/*---------------------------------------------------------------------------*/
60/*---------------------------------------------------------------------------*/
61
62#endif
Arcane::IBinaryMathFunctor
Interface of a binary mathematical function.
Definition IMathFunctor.h:33
Arcane::IStandardFunction
Interface managing a standard function.
Definition IStandardFunction.h:41
Arcane
-- tab-width: 2; indent-tabs-mode: nil; coding: utf-8-with-signature --
Definition AbstractCaseDocumentVisitor.cc:21