Nektar++
CommCwipi.h
Go to the documentation of this file.
1///////////////////////////////////////////////////////////////////////////////
2//
3// File: CommCwipi.h
4//
5// For more information, please see: http://www.nektar.info
6//
7// The MIT License
8//
9// Copyright (c) 2018 Kilian Lackhove
10// Copyright (c) 2006 Division of Applied Mathematics, Brown University (USA),
11// Department of Aeronautics, Imperial College London (UK), and Scientific
12// Computing and Imaging Institute, University of Utah (USA).
13//
14// Permission is hereby granted, free of charge, to any person obtaining a
15// copy of this software and associated documentation files (the "Software"),
16// to deal in the Software without restriction, including without limitation
17// the rights to use, copy, modify, merge, publish, distribute, sublicense,
18// and/or sell copies of the Software, and to permit persons to whom the
19// Software is furnished to do so, subject to the following conditions:
20//
21// The above copyright notice and this permission notice shall be included
22// in all copies or substantial portions of the Software.
23//
24// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
25// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
26// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
27// THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
28// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
29// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
30// DEALINGS IN THE SOFTWARE.
31//
32// Description: CommCwipi header
33//
34///////////////////////////////////////////////////////////////////////////////
35#ifndef NEKTAR_LIB_UTILITIES_COMMCWIPI_H
36#define NEKTAR_LIB_UTILITIES_COMMCWIPI_H
37
38#include <mpi.h>
39#include <string>
40
43
45{
46// Forward declarations
47class CommCwipi;
48
49/// Pointer to a Communicator object.
50typedef std::shared_ptr<CommCwipi> CommCwipiSharedPtr;
51
52/// A global linear system.
53class CommCwipi : public CommMpi
54{
55
56public:
57 /// Creates an instance of this class
58 static CommSharedPtr create(int narg, char *arg[])
59 {
61 }
62
63 /// Name of class
64 static std::string className;
65
66 CommCwipi(int narg, char *arg[]);
67
68 ~CommCwipi() override;
69
70protected:
71 void v_Finalise() override;
72};
73} // namespace Nektar::LibUtilities
74
75#endif
A global linear system.
Definition: CommCwipi.h:54
static CommSharedPtr create(int narg, char *arg[])
Creates an instance of this class.
Definition: CommCwipi.h:58
static std::string className
Name of class.
Definition: CommCwipi.h:64
CommCwipi(int narg, char *arg[])
Definition: CommCwipi.cpp:53
A global linear system.
Definition: CommMpi.h:90
static std::shared_ptr< DataType > AllocateSharedPtr(const Args &...args)
Allocate a shared pointer from the memory pool.
std::shared_ptr< Comm > CommSharedPtr
Pointer to a Communicator object.
Definition: Comm.h:55
std::shared_ptr< CommCwipi > CommCwipiSharedPtr
Pointer to a Communicator object.
Definition: CommCwipi.h:50