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

Inner Product operator using sum-factorisation (Hex) More...

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

Public Member Functions

 ~IProductWRTBase_SumFac_Hex () final=default
 
void operator() (const Array< OneD, const NekDouble > &input, Array< OneD, NekDouble > &output, 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
 
void CheckFactors (StdRegions::FactorMap factors, int coll_phys_offset) override
 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 ~Operator ()=default
 
virtual COLLECTIONS_EXPORT void operator() (const Array< OneD, const NekDouble > &input, Array< OneD, NekDouble > &output0, Array< OneD, NekDouble > &output1, Array< OneD, NekDouble > &output2, Array< OneD, NekDouble > &wsp=NullNekDouble1DArray)=0
 Perform operation. More...
 
virtual COLLECTIONS_EXPORT void operator() (int dir, const Array< OneD, const NekDouble > &input, Array< OneD, NekDouble > &output, Array< OneD, NekDouble > &wsp=NullNekDouble1DArray)=0
 
virtual COLLECTIONS_EXPORT void CheckFactors (StdRegions::FactorMap factors, int coll_phys_offset)=0
 Check the validity of the supplied factor map. More...
 
unsigned int GetWspSize ()
 Get the size of the required workspace. More...
 
unsigned int GetNumElmt ()
 Get number of elements. More...
 
StdRegions::StdExpansionSharedPtr GetExpSharedPtr ()
 Get expansion pointer. More...
 
unsigned int GetInputSize ()
 
unsigned int GetOutputSize ()
 

Protected Attributes

const int m_nquad0
 
const int m_nquad1
 
const int m_nquad2
 
const int m_nmodes0
 
const int m_nmodes1
 
const int m_nmodes2
 
const bool m_colldir0
 
const bool m_colldir1
 
const bool m_colldir2
 
Array< OneD, const NekDoublem_jacWStdW
 
Array< OneD, const NekDoublem_base0
 
Array< OneD, const NekDoublem_base1
 
Array< OneD, const NekDoublem_base2
 
- Protected Attributes inherited from Nektar::Collections::Operator
bool m_isDeformed
 
StdRegions::StdExpansionSharedPtr m_stdExp
 
unsigned int m_numElmt
 number of elements that the operator is applied on More...
 
unsigned int m_nqe
 
unsigned int m_wspSize
 
unsigned int m_inputSize
 number of modes or quadrature points that are passed as input to an operator More...
 
unsigned int m_outputSize
 number of modes or quadrature points that are taken as output from an operator More...
 

Private Member Functions

 IProductWRTBase_SumFac_Hex (vector< StdRegions::StdExpansionSharedPtr > pCollExp, CoalescedGeomDataSharedPtr pGeomData, StdRegions::FactorMap factors)
 

Additional Inherited Members

- Protected Member Functions inherited from Nektar::Collections::Operator
virtual int v_GetInputSize ()
 This purely virtual function needs to be set-up for every operator inside Collections. It is responsible for returning the size of input collection, that the operator is applied on either in physical or coefficient space. More...
 
virtual int v_GetOutputSize ()
 This purely virtual function needs to be set-up for every operator inside Collections. It is responsible for returning the output size either in physical or coefficient space of an operator inside Collections. More...
 
- Protected Member Functions inherited from Nektar::Collections::IProductWRTBase_Helper
 IProductWRTBase_Helper ()
 

Detailed Description

Inner Product operator using sum-factorisation (Hex)

Definition at line 719 of file IProductWRTBase.cpp.

Constructor & Destructor Documentation

◆ ~IProductWRTBase_SumFac_Hex()

Nektar::Collections::IProductWRTBase_SumFac_Hex::~IProductWRTBase_SumFac_Hex ( )
finaldefault

◆ IProductWRTBase_SumFac_Hex()

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

Definition at line 770 of file IProductWRTBase.cpp.

773 : Operator(pCollExp, pGeomData, factors), IProductWRTBase_Helper(),
774 m_nquad0(m_stdExp->GetNumPoints(0)),
775 m_nquad1(m_stdExp->GetNumPoints(1)),
776 m_nquad2(m_stdExp->GetNumPoints(2)),
777 m_nmodes0(m_stdExp->GetBasisNumModes(0)),
778 m_nmodes1(m_stdExp->GetBasisNumModes(1)),
779 m_nmodes2(m_stdExp->GetBasisNumModes(2)),
780 m_colldir0(m_stdExp->GetBasis(0)->Collocation()),
781 m_colldir1(m_stdExp->GetBasis(1)->Collocation()),
782 m_colldir2(m_stdExp->GetBasis(2)->Collocation()),
783 m_base0(m_stdExp->GetBasis(0)->GetBdata()),
784 m_base1(m_stdExp->GetBasis(1)->GetBdata()),
785 m_base2(m_stdExp->GetBasis(2)->GetBdata())
786
787 {
788 m_jacWStdW = pGeomData->GetJacWithStdWeights(pCollExp);
789 m_wspSize = 3 * m_numElmt *
790 (max(m_nquad0 * m_nquad1 * m_nquad2,
792 }
StdRegions::StdExpansionSharedPtr m_stdExp
Definition: Operator.h:188
unsigned int m_numElmt
number of elements that the operator is applied on
Definition: Operator.h:190
Operator(std::vector< StdRegions::StdExpansionSharedPtr > pCollExp, std::shared_ptr< CoalescedGeomData > GeomData, StdRegions::FactorMap factors)
Constructor.
Definition: Operator.cpp:66
StdRegions::ConstFactorMap factors

References m_jacWStdW, m_nmodes0, m_nmodes1, m_nmodes2, m_nquad0, m_nquad1, m_nquad2, Nektar::Collections::Operator::m_numElmt, and Nektar::Collections::Operator::m_wspSize.

Member Function Documentation

◆ CheckFactors()

void Nektar::Collections::IProductWRTBase_SumFac_Hex::CheckFactors ( StdRegions::FactorMap  factors,
int  coll_phys_offset 
)
inlineoverridevirtual

Check the validity of the supplied factor map.

Implements Nektar::Collections::Operator.

Definition at line 748 of file IProductWRTBase.cpp.

750 {
751 ASSERTL0(false, "Not valid for this operator.");
752 }
#define ASSERTL0(condition, msg)
Definition: ErrorUtil.hpp:208

References ASSERTL0.

◆ operator()() [1/2]

void Nektar::Collections::IProductWRTBase_SumFac_Hex::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 727 of file IProductWRTBase.cpp.

732 {
733 ASSERTL1(wsp.size() == m_wspSize, "Incorrect workspace size");
734
737 m_base0, m_base1, m_base2, m_jacWStdW, input, output, wsp);
738 }
#define ASSERTL1(condition, msg)
Assert Level 1 – Debugging which is used whether in FULLDEBUG or DEBUG compilation mode....
Definition: ErrorUtil.hpp:242
void HexIProduct(bool colldir0, bool colldir1, bool colldir2, int numElmt, int nquad0, int nquad1, int nquad2, int nmodes0, int nmodes1, int nmodes2, const Array< OneD, const NekDouble > &base0, const Array< OneD, const NekDouble > &base1, const Array< OneD, const NekDouble > &base2, const Array< OneD, const NekDouble > &jac, const Array< OneD, const NekDouble > &input, Array< OneD, NekDouble > &output, Array< OneD, NekDouble > &wsp)
Definition: IProduct.cpp:170

References ASSERTL1, Nektar::Collections::HexIProduct(), m_base0, m_base1, m_base2, m_colldir0, m_colldir1, m_colldir2, m_jacWStdW, m_nmodes0, m_nmodes1, m_nmodes2, m_nquad0, m_nquad1, m_nquad2, Nektar::Collections::Operator::m_numElmt, and Nektar::Collections::Operator::m_wspSize.

◆ operator()() [2/2]

void Nektar::Collections::IProductWRTBase_SumFac_Hex::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 740 of file IProductWRTBase.cpp.

744 {
745 NEKERROR(ErrorUtil::efatal, "Not valid for this operator.");
746 }
#define NEKERROR(type, msg)
Assert Level 0 – Fundamental assert which is used whether in FULLDEBUG, DEBUG or OPT compilation mode...
Definition: ErrorUtil.hpp:202

References Nektar::ErrorUtil::efatal, and NEKERROR.

Member Data Documentation

◆ m_base0

Array<OneD, const NekDouble> Nektar::Collections::IProductWRTBase_SumFac_Hex::m_base0
protected

Definition at line 765 of file IProductWRTBase.cpp.

Referenced by operator()().

◆ m_base1

Array<OneD, const NekDouble> Nektar::Collections::IProductWRTBase_SumFac_Hex::m_base1
protected

Definition at line 766 of file IProductWRTBase.cpp.

Referenced by operator()().

◆ m_base2

Array<OneD, const NekDouble> Nektar::Collections::IProductWRTBase_SumFac_Hex::m_base2
protected

Definition at line 767 of file IProductWRTBase.cpp.

Referenced by operator()().

◆ m_colldir0

const bool Nektar::Collections::IProductWRTBase_SumFac_Hex::m_colldir0
protected

Definition at line 761 of file IProductWRTBase.cpp.

Referenced by operator()().

◆ m_colldir1

const bool Nektar::Collections::IProductWRTBase_SumFac_Hex::m_colldir1
protected

Definition at line 762 of file IProductWRTBase.cpp.

Referenced by operator()().

◆ m_colldir2

const bool Nektar::Collections::IProductWRTBase_SumFac_Hex::m_colldir2
protected

Definition at line 763 of file IProductWRTBase.cpp.

Referenced by operator()().

◆ m_jacWStdW

Array<OneD, const NekDouble> Nektar::Collections::IProductWRTBase_SumFac_Hex::m_jacWStdW
protected

Definition at line 764 of file IProductWRTBase.cpp.

Referenced by IProductWRTBase_SumFac_Hex(), and operator()().

◆ m_nmodes0

const int Nektar::Collections::IProductWRTBase_SumFac_Hex::m_nmodes0
protected

Definition at line 758 of file IProductWRTBase.cpp.

Referenced by IProductWRTBase_SumFac_Hex(), and operator()().

◆ m_nmodes1

const int Nektar::Collections::IProductWRTBase_SumFac_Hex::m_nmodes1
protected

Definition at line 759 of file IProductWRTBase.cpp.

Referenced by IProductWRTBase_SumFac_Hex(), and operator()().

◆ m_nmodes2

const int Nektar::Collections::IProductWRTBase_SumFac_Hex::m_nmodes2
protected

Definition at line 760 of file IProductWRTBase.cpp.

Referenced by IProductWRTBase_SumFac_Hex(), and operator()().

◆ m_nquad0

const int Nektar::Collections::IProductWRTBase_SumFac_Hex::m_nquad0
protected

Definition at line 755 of file IProductWRTBase.cpp.

Referenced by IProductWRTBase_SumFac_Hex(), and operator()().

◆ m_nquad1

const int Nektar::Collections::IProductWRTBase_SumFac_Hex::m_nquad1
protected

Definition at line 756 of file IProductWRTBase.cpp.

Referenced by IProductWRTBase_SumFac_Hex(), and operator()().

◆ m_nquad2

const int Nektar::Collections::IProductWRTBase_SumFac_Hex::m_nquad2
protected

Definition at line 757 of file IProductWRTBase.cpp.

Referenced by IProductWRTBase_SumFac_Hex(), and operator()().