Nektar++
Python/StdMatrixKey.cpp
Go to the documentation of this file.
1////////////////////////////////////////////////////////////////////////////////
2//
3// File: StdMatrixKey.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 StdMatrixKey.
32//
33////////////////////////////////////////////////////////////////////////////////
34
37
38#include <vector>
39
42
43using namespace Nektar;
44using namespace Nektar::StdRegions;
45
48
50 const MatrixType matType, const LibUtilities::ShapeType shapeType,
51 const StdExpansionSharedPtr exp, const ConstFactorMap &constFactorMap,
52 const VarCoeffMap &varCoeffMap)
53{
54 return std::make_unique<StdMatrixKey>(matType, shapeType, *exp,
55 constFactorMap, varCoeffMap);
56}
57
58/**
59 * @brief Export for StdMatrixKey enumeration.
60 */
61void export_StdMatrixKey(py::module &m)
62{
66
67 // Wrapper for constant factor map.
68 py::bind_map<ConstFactorMap>(m, "ConstFactorMap");
69
70 // Wrapper for variable coefficients map.
71 py::bind_map<VarCoeffMap>(m, "VarCoeffMap");
72
73 py::class_<StdMatrixKey>(m, "StdMatrixKey")
74 .def(py::init(&StdMatrixKey_Init), py::arg("matType"),
75 py::arg("shapeType"), py::arg("exp"),
76 py::arg("constFactorMap") = NullConstFactorMap,
77 py::arg("varCoeffMap") = NullVarCoeffMap)
78
79 .def("GetMatrixType", &StdMatrixKey::GetMatrixType)
80 .def("GetShapeType", &StdMatrixKey::GetShapeType)
81 .def("GetNcoeffs", &StdMatrixKey::GetNcoeffs)
82 .def("GetBasis", &StdMatrixKey::GetBasis);
83}
#define NEKPY_WRAP_ENUM(MOD, ENUMNAME, MAPNAME)
Definition: NekPyConfig.hpp:53
std::unique_ptr< StdMatrixKey > StdMatrixKey_Init(const MatrixType matType, const LibUtilities::ShapeType shapeType, const StdExpansionSharedPtr exp, const ConstFactorMap &constFactorMap, const VarCoeffMap &varCoeffMap)
void export_StdMatrixKey(py::module &m)
Export for StdMatrixKey enumeration.
PYBIND11_MAKE_OPAQUE(LibUtilities::FieldMetaDataMap)
std::shared_ptr< StdExpansion > StdExpansionSharedPtr
const char *const VarCoeffTypeMap[]
Definition: StdRegions.hpp:234
const char *const ConstFactorTypeMap[]
Definition: StdRegions.hpp:413
const char *const MatrixTypeMap[]
Definition: StdRegions.hpp:139
std::map< ConstFactorType, NekDouble > ConstFactorMap
Definition: StdRegions.hpp:430
static ConstFactorMap NullConstFactorMap
Definition: StdRegions.hpp:431
static VarCoeffMap NullVarCoeffMap
Definition: StdRegions.hpp:376
std::map< StdRegions::VarCoeffType, VarCoeffEntry > VarCoeffMap
Definition: StdRegions.hpp:375
STL namespace.