Nektar++
Python/Foundations/Basis.cpp
Go to the documentation of this file.
1 ///////////////////////////////////////////////////////////////////////////////
2 //
3 // File: Basis.cpp
4 //
5 // For more information, please see: http://www.nektar.info
6 //
7 // The MIT License
8 //
9 // Copyright (c) 2006 Division of Applied Mathematics, Brown University (USA),
10 // Department of Aeronautics, Imperial College London (UK), and Scientific
11 // Computing and Imaging Institute, University of Utah (USA).
12 //
13 // Permission is hereby granted, free of charge, to any person obtaining a
14 // copy of this software and associated documentation files (the "Software"),
15 // to deal in the Software without restriction, including without limitation
16 // the rights to use, copy, modify, merge, publish, distribute, sublicense,
17 // and/or sell copies of the Software, and to permit persons to whom the
18 // Software is furnished to do so, subject to the following conditions:
19 //
20 // The above copyright notice and this permission notice shall be included
21 // in all copies or substantial portions of the Software.
22 //
23 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
24 // OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
25 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
26 // THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
27 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
28 // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
29 // DEALINGS IN THE SOFTWARE.
30 //
31 // Description: Python wrapper for Basis.
32 //
33 ///////////////////////////////////////////////////////////////////////////////
34 
37 
39 
40 using namespace Nektar::LibUtilities;
41 
43 {
44  return BasisManager()[pts];
45 }
46 
48 {
49  return py::make_tuple(pts->GetZ(), pts->GetW());
50 }
51 
52 /**
53  * @brief Basis exports.
54  */
56 {
57  // Enumerator for basis type
59 
60  py::class_<BasisKey>(
61  "BasisKey", py::init<const BasisType &, const int, const PointsKey &>())
62 
63  .def("GetNumModes", &BasisKey::GetNumModes)
64  .def("GetTotNumModes", &BasisKey::GetTotNumModes)
65  .def("GetNumPoints", &BasisKey::GetNumPoints)
66  .def("GetTotNumPoints", &BasisKey::GetTotNumPoints)
67  .def("GetBasisType", &BasisKey::GetBasisType)
68  .def("GetPointsKey", &BasisKey::GetPointsKey)
69  .def("GetPointsType", &BasisKey::GetPointsType)
70  .def("Collocation", &BasisKey::Collocation);
71 
72  py::class_<Basis, std::shared_ptr<Basis>>("Basis", py::no_init)
73 
74  .def("Create", &Basis_Create)
75  .staticmethod("Create")
76 
77  .def("GetNumModes", &Basis::GetNumModes)
78  .def("GetTotNumModes", &Basis::GetTotNumModes)
79  .def("GetNumPoints", &Basis::GetNumPoints)
80  .def("GetTotNumPoints", &Basis::GetTotNumPoints)
81  .def("GetBasisType", &Basis::GetBasisType)
82  .def("GetPointsKey", &Basis::GetPointsKey)
83  .def("GetBasisKey", &Basis::GetBasisKey)
84  .def("GetPointsType", &Basis::GetBasisType)
85  .def("Initialize", &Basis::Initialize)
86 
87  .def("GetZ", &Basis::GetZ,
88  py::return_value_policy<py::copy_const_reference>())
89  .def("GetW", &Basis::GetW,
90  py::return_value_policy<py::copy_const_reference>())
91  .def("GetZW", &Basis_GetZW)
92 
93  .def("GetBdata", &Basis::GetBdata,
94  py::return_value_policy<py::copy_const_reference>())
95  .def("GetDbdata", &Basis::GetDbdata,
96  py::return_value_policy<py::copy_const_reference>());
97 }
#define NEKPY_WRAP_ENUM(ENUMNAME, MAPNAME)
Definition: NekPyConfig.hpp:69
BasisSharedPtr Basis_Create(const BasisKey &pts)
void export_Basis()
Basis exports.
py::tuple Basis_GetZW(BasisSharedPtr pts)
int GetNumModes() const
Return order of basis from the basis specification.
Definition: Basis.h:222
int GetTotNumModes() const
Return total number of modes from the basis specification.
Definition: Basis.h:228
const Array< OneD, const NekDouble > & GetBdata() const
Return basis definition array m_bdata.
Definition: Basis.h:316
PointsKey GetPointsKey() const
Return the points specification for the basis.
Definition: Basis.h:252
int GetTotNumPoints() const
Return total number of points from the basis specification.
Definition: Basis.h:240
const Array< OneD, const NekDouble > & GetZ() const
Definition: Basis.h:263
const Array< OneD, const NekDouble > & GetW() const
Definition: Basis.h:268
const BasisKey GetBasisKey() const
Returns the specification for the Basis.
Definition: Basis.h:328
BasisType GetBasisType() const
Return the type of expansion basis.
Definition: Basis.h:246
int GetNumPoints() const
Return the number of points from the basis specification.
Definition: Basis.h:234
const Array< OneD, const NekDouble > & GetDbdata() const
Return basis definition array m_dbdata.
Definition: Basis.h:322
Describes the specification for a Basis.
Definition: Basis.h:50
int GetNumPoints() const
Return points order at which basis is defined.
Definition: Basis.h:130
BasisType GetBasisType() const
Return type of expansion basis.
Definition: Basis.h:141
PointsKey GetPointsKey() const
Return distribution of points.
Definition: Basis.h:147
int GetTotNumPoints() const
Definition: Basis.h:135
int GetTotNumModes() const
Definition: Basis.h:89
int GetNumModes() const
Returns the order of the basis.
Definition: Basis.h:83
PointsType GetPointsType() const
Return type of quadrature.
Definition: Basis.h:153
bool Collocation() const
Determine if basis has collocation properties.
BasisManagerT & BasisManager(void)
std::shared_ptr< Basis > BasisSharedPtr
const char *const BasisTypeMap[]
Definition: Foundations.hpp:46