Nektar++
Public Member Functions | Private Member Functions | Private Attributes | List of all members
Nektar::Collections::BwdTrans_MatrixFree Class Referencefinal

Backward transform operator using matrix free operators. More...

Inheritance diagram for Nektar::Collections::BwdTrans_MatrixFree:
[legend]

Public Member Functions

 ~BwdTrans_MatrixFree () final
 
void operator() (const Array< OneD, const NekDouble > &input, Array< OneD, NekDouble > &output0, Array< OneD, NekDouble > &output1, Array< OneD, NekDouble > &output2, Array< OneD, NekDouble > &wsp) final
 Perform operation. More...
 
void operator() (int dir, const Array< OneD, const NekDouble > &input, Array< OneD, NekDouble > &output, Array< OneD, NekDouble > &wsp) final
 
virtual void CheckFactors (StdRegions::FactorMap factors, int coll_phys_offset)
 Check the validity of the supplied factor map. More...
 
- Public Member Functions inherited from Nektar::Collections::Operator
 Operator (std::vector< StdRegions::StdExpansionSharedPtr > pCollExp, std::shared_ptr< CoalescedGeomData > GeomData, StdRegions::FactorMap factors)
 Constructor. More...
 
virtual COLLECTIONS_EXPORT ~Operator ()
 
unsigned int GetWspSize ()
 Get the size of the required workspace. More...
 
unsigned int GetNumElmt ()
 Get expansion pointer. More...
 
StdRegions::StdExpansionSharedPtr GetExpSharedPtr ()
 Get expansion pointer. More...
 

Private Member Functions

 BwdTrans_MatrixFree (vector< StdRegions::StdExpansionSharedPtr > pCollExp, CoalescedGeomDataSharedPtr pGeomData, StdRegions::FactorMap factors)
 
- Private Member Functions inherited from Nektar::Collections::MatrixFreeOneInOneOut
 MatrixFreeOneInOneOut (const unsigned int nIn, const unsigned int nOut, const unsigned int nCollSize)
 Constructor. More...
 

Private Attributes

std::shared_ptr< MatrixFree::BwdTrans > m_oper
 
- Private Attributes inherited from Nektar::Collections::MatrixFreeOneInOneOut
Array< OneD, NekDoublem_input
 padded input/output vectors More...
 
Array< OneD, NekDoublem_output
 

Additional Inherited Members

- Protected Attributes inherited from Nektar::Collections::Operator
bool m_isDeformed
 
StdRegions::StdExpansionSharedPtr m_stdExp
 
unsigned int m_numElmt
 
unsigned int m_nqe
 
unsigned int m_wspSize
 

Detailed Description

Backward transform operator using matrix free operators.

Definition at line 150 of file BwdTrans.cpp.

Constructor & Destructor Documentation

◆ ~BwdTrans_MatrixFree()

Nektar::Collections::BwdTrans_MatrixFree::~BwdTrans_MatrixFree ( )
inlinefinal

Definition at line 155 of file BwdTrans.cpp.

156  {
157  }

◆ BwdTrans_MatrixFree()

Nektar::Collections::BwdTrans_MatrixFree::BwdTrans_MatrixFree ( vector< StdRegions::StdExpansionSharedPtr pCollExp,
CoalescedGeomDataSharedPtr  pGeomData,
StdRegions::FactorMap  factors 
)
inlineprivate

Definition at line 202 of file BwdTrans.cpp.

205  : Operator(pCollExp, pGeomData, factors),
206  MatrixFreeOneInOneOut(pCollExp[0]->GetStdExp()->GetNcoeffs(),
207  pCollExp[0]->GetStdExp()->GetTotPoints(),
208  pCollExp.size())
209  {
210  // Basis vector.
211  const auto dim = pCollExp[0]->GetStdExp()->GetShapeDimension();
212  std::vector<LibUtilities::BasisSharedPtr> basis(dim);
213  for (auto i = 0; i < dim; ++i)
214  {
215  basis[i] = pCollExp[0]->GetBasis(i);
216  }
217 
218  // Get shape type
219  auto shapeType = pCollExp[0]->GetStdExp()->DetShapeType();
220 
221  // Generate operator string and create operator.
222  std::string op_string = "BwdTrans";
223  op_string += MatrixFree::GetOpstring(shapeType, false);
225  op_string, basis, m_nElmtPad);
226 
227  m_oper = std::dynamic_pointer_cast<MatrixFree::BwdTrans>(oper);
228  ASSERTL0(m_oper, "Failed to cast pointer.");
229  }
#define ASSERTL0(condition, msg)
Definition: ErrorUtil.hpp:216
std::shared_ptr< MatrixFree::BwdTrans > m_oper
Definition: BwdTrans.cpp:200
unsigned int m_nElmtPad
size after padding
MatrixFreeOneInOneOut(const unsigned int nIn, const unsigned int nOut, const unsigned int nCollSize)
Constructor.
Operator(std::vector< StdRegions::StdExpansionSharedPtr > pCollExp, std::shared_ptr< CoalescedGeomData > GeomData, StdRegions::FactorMap factors)
Constructor.
Definition: Operator.cpp:41
tBaseSharedPtr CreateInstance(tKey idKey, tParam... args)
Create an instance of the class referred to by idKey.
Definition: NekFactory.hpp:145
OperatorFactory & GetOperatorFactory()
Returns the singleton Operator factory object.
Definition: Operator.cpp:121

References ASSERTL0, Nektar::LibUtilities::NekFactory< tKey, tBase, tParam >::CreateInstance(), and Nektar::Collections::GetOperatorFactory().

Member Function Documentation

◆ CheckFactors()

virtual void Nektar::Collections::BwdTrans_MatrixFree::CheckFactors ( StdRegions::FactorMap  factors,
int  coll_phys_offset 
)
inlinevirtual

Check the validity of the supplied factor map.

Implements Nektar::Collections::Operator.

Definition at line 191 of file BwdTrans.cpp.

193  {
194  boost::ignore_unused(factors, coll_phys_offset);
195  ASSERTL0(false, "Not valid for this operator.");
196  }

References ASSERTL0.

◆ operator()() [1/2]

void Nektar::Collections::BwdTrans_MatrixFree::operator() ( const Array< OneD, const NekDouble > &  input,
Array< OneD, NekDouble > &  output0,
Array< OneD, NekDouble > &  output1,
Array< OneD, NekDouble > &  output2,
Array< OneD, NekDouble > &  wsp 
)
inlinefinalvirtual

Perform operation.

Implements Nektar::Collections::Operator.

Definition at line 159 of file BwdTrans.cpp.

164  {
165  boost::ignore_unused(output1, output2, wsp);
166 
167  if (m_isPadded)
168  {
169  // copy into padded vector
170  Vmath::Vcopy(m_nIn, input, 1, m_input, 1);
171  // call op
172  (*m_oper)(m_input, m_output);
173  // copy out of padded vector
174  Vmath::Vcopy(m_nOut, m_output, 1, output0, 1);
175  }
176  else
177  {
178  (*m_oper)(input, output0);
179  }
180  }
Array< OneD, NekDouble > m_input
padded input/output vectors
void Vcopy(int n, const T *x, const int incx, T *y, const int incy)
Definition: Vmath.cpp:1199

References Vmath::Vcopy().

◆ operator()() [2/2]

void Nektar::Collections::BwdTrans_MatrixFree::operator() ( int  dir,
const Array< OneD, const NekDouble > &  input,
Array< OneD, NekDouble > &  output,
Array< OneD, NekDouble > &  wsp 
)
inlinefinalvirtual

Implements Nektar::Collections::Operator.

Definition at line 182 of file BwdTrans.cpp.

185  {
186  boost::ignore_unused(dir, input, output, wsp);
188  "BwdTrans_MatrixFree: Not valid for this operator.");
189  }
#define NEKERROR(type, msg)
Assert Level 0 – Fundamental assert which is used whether in FULLDEBUG, DEBUG or OPT compilation mode...
Definition: ErrorUtil.hpp:209

References NEKERROR.

Member Data Documentation

◆ m_oper

std::shared_ptr<MatrixFree::BwdTrans> Nektar::Collections::BwdTrans_MatrixFree::m_oper
private

Definition at line 200 of file BwdTrans.cpp.