Arcane  4.1.12.0
Developer documentation
Loading...
Searching...
No Matches
IVariableUtilities.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/* IVariableUtilities.h (C) 2000-2025 */
9/* */
10/* Interface providing utility functions on variables. */
11/*---------------------------------------------------------------------------*/
12#ifndef ARCANE_CORE_IVARIABLEUTILITIES_H
13#define ARCANE_CORE_IVARIABLEUTILITIES_H
14/*---------------------------------------------------------------------------*/
15/*---------------------------------------------------------------------------*/
16
17#include "arcane/core/ArcaneTypes.h"
18
19/*---------------------------------------------------------------------------*/
20/*---------------------------------------------------------------------------*/
21
22namespace Arcane
23{
24
25/*---------------------------------------------------------------------------*/
26/*---------------------------------------------------------------------------*/
27
31class ARCANE_CORE_EXPORT IVariableUtilities
32{
33 public:
34
35 virtual ~IVariableUtilities() = default;
36
37 public:
38
40 virtual IVariableMng* variableMng() const = 0;
41
49 virtual void dumpDependencies(IVariable* var, std::ostream& ostr, bool is_recursive) = 0;
50
57 virtual void dumpAllVariableDependencies(std::ostream& ostr, bool is_recursive) = 0;
58
70 virtual VariableCollection filterCommonVariables(IParallelMng* pm,
71 VariableCollection input_variables,
72 bool dump_not_common) = 0;
73};
74
75/*---------------------------------------------------------------------------*/
76/*---------------------------------------------------------------------------*/
77
78} // namespace Arcane
79
80/*---------------------------------------------------------------------------*/
81/*---------------------------------------------------------------------------*/
82
83#endif
ArcaneTypes.h
Declarations of Arcane's general types.
Arcane::IParallelMng
Interface of the parallelism manager for a subdomain.
Definition IParallelMng.h:53
Arcane::IVariableMng
Variable manager interface.
Definition IVariableMng.h:58
Arcane::IVariableUtilities
Interface providing utility functions on variables.
Definition IVariableUtilities.h:32
Arcane::IVariableUtilities::dumpAllVariableDependencies
virtual void dumpAllVariableDependencies(std::ostream &ostr, bool is_recursive)=0
Displays dependency information for all variables.
Arcane::IVariableUtilities::filterCommonVariables
virtual VariableCollection filterCommonVariables(IParallelMng *pm, VariableCollection input_variables, bool dump_not_common)=0
Filters common variables between multiple ranks.
Arcane::IVariableUtilities::dumpDependencies
virtual void dumpDependencies(IVariable *var, std::ostream &ostr, bool is_recursive)=0
Displays dependency information for a variable.
Arcane::IVariableUtilities::variableMng
virtual IVariableMng * variableMng() const =0
Associated variable manager.
Arcane::IVariableUtilities::~IVariableUtilities
virtual ~IVariableUtilities()=default
Frees resources.
Arcane::IVariable
Interface of a variable.
Definition IVariable.h:40
Arcane
-- tab-width: 2; indent-tabs-mode: nil; coding: utf-8-with-signature --
Definition arcane/src/arcane/accelerator/AcceleratorGlobal.h:37