Arcane  4.1.12.0
User documentation
Loading...
Searching...
No Matches
IDirectSubDomainExecuteFunctor.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/* IDirectSubDomainExecuteFunctor.h (C) 2000-2025 */
9/* */
10/* Interface of a direct execution functor with subdomain. */
11/*---------------------------------------------------------------------------*/
12#ifndef ARCANE_CORE_IDIRECTSUBDOMAINEXECUTEFUNCTOR_H
13#define ARCANE_CORE_IDIRECTSUBDOMAINEXECUTEFUNCTOR_H
14/*---------------------------------------------------------------------------*/
15/*---------------------------------------------------------------------------*/
16
17#include "arcane/core/ArcaneTypes.h"
18
19/*---------------------------------------------------------------------------*/
20/*---------------------------------------------------------------------------*/
21
22namespace Arcane
23{
24
25/*---------------------------------------------------------------------------*/
26/*---------------------------------------------------------------------------*/
27
28/*!
29 * \internal
30 * \brief Interface of a functor to execute code directly after
31 * the creation of a subdomain without going through the time loop.
32 */
33class ARCANE_CORE_EXPORT IDirectSubDomainExecuteFunctor
34{
35 public:
36
37 virtual ~IDirectSubDomainExecuteFunctor() = default;
38
39 public:
40
41 //! Executes the functor's operation
42 virtual int execute() = 0;
43
44 /*!
45 * \brief Positions the associated subdomain.
46 * This method must be called before execute()
47 */
48 virtual void setSubDomain(ISubDomain* sd) = 0;
49};
50
51/*---------------------------------------------------------------------------*/
52/*---------------------------------------------------------------------------*/
53
54} // End namespace Arcane
55
56/*---------------------------------------------------------------------------*/
57/*---------------------------------------------------------------------------*/
58
59#endif
ArcaneTypes.h
Declarations of Arcane's general types.
Arcane::IDirectSubDomainExecuteFunctor::execute
virtual int execute()=0
Executes the functor's operation.
Arcane::IDirectSubDomainExecuteFunctor::setSubDomain
virtual void setSubDomain(ISubDomain *sd)=0
Positions the associated subdomain. This method must be called before execute().
Arcane::ISubDomain
Interface of the subdomain manager.
Definition ISubDomain.h:75
Arcane
-- tab-width: 2; indent-tabs-mode: nil; coding: utf-8-with-signature --
Definition AbstractCaseDocumentVisitor.cc:21