File: Coupling.py

package info (click to toggle)
code-saturne 6.0.2-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, bullseye, sid
  • size: 63,340 kB
  • sloc: ansic: 354,724; f90: 119,812; python: 87,716; makefile: 4,653; cpp: 4,272; xml: 2,839; sh: 1,228; lex: 170; yacc: 100
file content (137 lines) | stat: -rw-r--r-- 4,895 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
# ==============================================================================
#  This file is part of the "Parallel Location and Exchange" library,
#  intended to provide mesh or particle-based code coupling services.
#
#  Copyright (C) 2005-2019  EDF S.A.
#
#  This library is free software; you can redistribute it and/or
#  modify it under the terms of the GNU Lesser General Public
#  License as published by the Free Software Foundation; either
#  version 2.1 of the License, or (at your option) any later version.
#
#  This library is distributed in the hope that it will be useful,
#  but WITHOUT ANY WARRANTY; without even the implied warranty of
#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
#  Lesser General Public License for more details.
#
#  You should have received a copy of the GNU Lesser General Public
#  License along with this library; if not, write to the Free Software
#  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
# ==============================================================================

# ==============================================================================
# Python wrapping for ple_coupling_* functions calls.
# Contains the ple_mpi_set python class which provides methods which call
# upon the ple_coupling C functions.
# ==============================================================================

# ==============================================================================
# Import the .so libray created using .c wrapper
import libpyplecoupling as pyplec
# ==============================================================================

# ==============================================================================
# Retrieve the PLE flags masks
PLE_COUPLING_FLAGS = pyplec.coupling_get_masks()
# ==============================================================================

# ==============================================================================
def name_to_id(Comm, name):
    """
    Return the id of the app with name "name" within the communicator
    """

    new_id = pyplec.coupling_mpi_name_to_id(Comm, name)

    return new_id
# ==============================================================================

# ==============================================================================
# Finalize usage of the Coupling module
def finalize():

    pyplec.coupling_mpi_set_destroy_all()

    return

# ==============================================================================

# ==============================================================================
# MPI set class
class ple_mpi_set(object):
    """
    Python class which allows a manipulation of a ple_coupling_mpi_set_t.
    This class also contains methods which correspond to the different
    PLE functions which call upon a ple_coupling_mpi_set.
    """

    def __init__(self, sync_flags, app_type, app_name, base_comm, app_comm):
        """
        Initialization function
        """

        try:
            self.idx = pyplec.coupling_mpi_set_create(sync_flags,
                                                      app_type,
                                                      app_name,
                                                      base_comm,
                                                      app_comm)
        except:
            raise Exception("ple mpi set create failed...")

        self.n_apps = pyplec.coupling_mpi_set_n_apps(self.idx)

        self.app_id = pyplec.coupling_mpi_set_get_app_id(self.idx)

    def get_info(self, app_id):
        """
        Return app information under the form of a dictionnary.
        """

        return pyplec.coupling_mpi_set_get_info(self.idx, app_id)

    def get_n_apps(self):
        """
        Return the number of apps in the MPI set
        """

        return self.n_apps

    def get_app_id(self):
        """
        Return the app id of the code making the call
        """

        return self.app_id

    def synchronize(self, sync_flags, time_step):
        """
        Synchronize the different codes in the MPI set.
        Flag choices are available in Coupling.PLE_FLAGS dictionnary
        """

        pyplec.coupling_mpi_set_synchronize(self.idx, sync_flags, time_step)

    def get_status(self):
        """
        Return a list of status' for all applications within the set
        """

        return pyplec.coupling_mpi_set_get_status(self.idx)

    def get_timesteps(self):
        """
        Return a list containing the time steps of all applications after a
        call to synchronize.
        """

        return pyplec.coupling_mpi_set_get_timestep(self.idx)

    def dump(self):
        """
        Dump MPI set information to stdout.
        """

        pyplec.coupling_mpi_set_dump(self.idx)
# ==============================================================================