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

Inner product WRT deriv base operator using sum-factorisation (Prism) More...

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

Public Member Functions

 ~IProductWRTDerivBase_SumFac_Prism () final=default
 
void operator() (const Array< OneD, const NekDouble > &entry0, Array< OneD, NekDouble > &entry1, Array< OneD, NekDouble > &entry2, Array< OneD, NekDouble > &entry3, Array< OneD, NekDouble > &wsp) final
 
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
 
Array< OneD, const NekDoublem_jacWStdW
 
Array< OneD, const NekDoublem_base0
 
Array< OneD, const NekDoublem_base1
 
Array< OneD, const NekDoublem_base2
 
Array< OneD, const NekDoublem_derbase0
 
Array< OneD, const NekDoublem_derbase1
 
Array< OneD, const NekDoublem_derbase2
 
Array< TwoD, const NekDoublem_derivFac
 
Array< OneD, NekDoublem_fac0
 
Array< OneD, NekDoublem_fac1
 
bool m_sortTopVertex
 
- 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

 IProductWRTDerivBase_SumFac_Prism (vector< StdRegions::StdExpansionSharedPtr > pCollExp, CoalescedGeomDataSharedPtr pGeomData, StdRegions::FactorMap factors)
 
- Private Member Functions inherited from Nektar::Collections::IProductWRTDerivBase_Helper
 IProductWRTDerivBase_Helper ()
 

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...
 

Detailed Description

Inner product WRT deriv base operator using sum-factorisation (Prism)

Definition at line 1659 of file IProductWRTDerivBase.cpp.

Constructor & Destructor Documentation

◆ ~IProductWRTDerivBase_SumFac_Prism()

Nektar::Collections::IProductWRTDerivBase_SumFac_Prism::~IProductWRTDerivBase_SumFac_Prism ( )
finaldefault

◆ IProductWRTDerivBase_SumFac_Prism()

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

Definition at line 1836 of file IProductWRTDerivBase.cpp.

1839 : Operator(pCollExp, pGeomData, factors), IProductWRTDerivBase_Helper(),
1840 m_nquad0(m_stdExp->GetNumPoints(0)),
1841 m_nquad1(m_stdExp->GetNumPoints(1)),
1842 m_nquad2(m_stdExp->GetNumPoints(2)),
1843 m_nmodes0(m_stdExp->GetBasisNumModes(0)),
1844 m_nmodes1(m_stdExp->GetBasisNumModes(1)),
1845 m_nmodes2(m_stdExp->GetBasisNumModes(2)),
1846 m_base0(m_stdExp->GetBasis(0)->GetBdata()),
1847 m_base1(m_stdExp->GetBasis(1)->GetBdata()),
1848 m_base2(m_stdExp->GetBasis(2)->GetBdata()),
1849 m_derbase0(m_stdExp->GetBasis(0)->GetDbdata()),
1850 m_derbase1(m_stdExp->GetBasis(1)->GetDbdata()),
1851 m_derbase2(m_stdExp->GetBasis(2)->GetDbdata())
1852
1853 {
1854 m_jacWStdW = pGeomData->GetJacWithStdWeights(pCollExp);
1855 m_wspSize = 6 * m_numElmt *
1856 (max(m_nquad0 * m_nquad1 * m_nquad2,
1858 m_derivFac = pGeomData->GetDerivFactors(pCollExp);
1859
1860 if (m_stdExp->GetBasis(0)->GetBasisType() == LibUtilities::eModified_A)
1861 {
1862 m_sortTopVertex = true;
1863 }
1864 else
1865 {
1866 m_sortTopVertex = false;
1867 }
1868
1869 const Array<OneD, const NekDouble> &z0 = m_stdExp->GetBasis(0)->GetZ();
1870 const Array<OneD, const NekDouble> &z2 = m_stdExp->GetBasis(2)->GetZ();
1871
1872 m_fac0 = Array<OneD, NekDouble>(m_nquad0 * m_nquad1 * m_nquad2);
1873 m_fac1 = Array<OneD, NekDouble>(m_nquad0 * m_nquad1 * m_nquad2);
1874
1875 for (int i = 0; i < m_nquad0; ++i)
1876 {
1877 for (int j = 0; j < m_nquad1; ++j)
1878 {
1879 for (int k = 0; k < m_nquad2; ++k)
1880 {
1881 // set up geometric factor: 2/(1-z1)
1882 m_fac0[i + j * m_nquad0 + k * m_nquad0 * m_nquad1] =
1883 2.0 / (1 - z2[k]);
1884 // set up geometric factor: (1+z0)/(1-z1)
1885 m_fac1[i + j * m_nquad0 + k * m_nquad0 * m_nquad1] =
1886 (1 + z0[i]) / (1 - z2[k]);
1887 }
1888 }
1889 }
1890 }
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
@ eModified_A
Principle Modified Functions .
Definition: BasisType.h:48
StdRegions::ConstFactorMap factors

References Nektar::LibUtilities::eModified_A, m_derivFac, m_fac0, m_fac1, m_jacWStdW, m_nmodes0, m_nmodes1, m_nmodes2, m_nquad0, m_nquad1, m_nquad2, Nektar::Collections::Operator::m_numElmt, m_sortTopVertex, Nektar::Collections::Operator::m_stdExp, and Nektar::Collections::Operator::m_wspSize.

Member Function Documentation

◆ CheckFactors()

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

Check the validity of the supplied factor map.

Implements Nektar::Collections::Operator.

Definition at line 1810 of file IProductWRTDerivBase.cpp.

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

References ASSERTL0.

◆ operator()() [1/2]

void Nektar::Collections::IProductWRTDerivBase_SumFac_Prism::operator() ( const Array< OneD, const NekDouble > &  entry0,
Array< OneD, NekDouble > &  entry1,
Array< OneD, NekDouble > &  entry2,
Array< OneD, NekDouble > &  entry3,
Array< OneD, NekDouble > &  wsp 
)
inlinefinalvirtual

This method calculates:

\[ (d\phi/dx,in[0]) + (d\phi/dy,in[1]) + (d\phi/dz,in[2]) \]

which can be represented in terms of local cartesian derivaties as:

\[ ((d\phi/d\xi_0\, d\xi_0/dx + d\phi/d\xi_1\, d\xi_1/dx + d\phi/d\xi_2\, d\xi_2/dx),in[0]) + \]

\[ ((d\phi/d\xi_0\, d\xi_0/dy + d\phi/d\xi_1\, d\xi_1/dy + d\phi/d\xi_2\, d\xi_2/dy),in[1]) + \]

\[ ((d\phi/d\xi_0\, d\xi_0/dz + d\phi/d\xi_1\, d\xi_1/dz + d\phi/d\xi_2\, d\xi_2/dz),in[2]) \, \]

where we note that

\[ d\phi/d\xi_0 = d\phi/d\eta_0 d\eta_0/d\xi_0 = d\phi/d\eta_0 2/(1-\eta_2) \]

\[ d\phi/d\xi_2 = d\phi/d\eta_0 d\eta_0/d\xi_2 + d\phi/d\eta_2 d\eta_2/d\xi_2 = d\phi/d\eta_0 (1+\eta_0)/(1-\eta_2) + d\phi/d\eta_2 \]

and so the full inner products are

\[ (d\phi/dx,in[0]) + (d\phi/dy,in[1]) + (d\phi/dz,in[2]) = \]

\[ (d\phi/d\eta_0, ((2/(1-\eta_2) (d\xi_0/dx in[0] + d\xi_0/dy in[1] + d\xi_0/dz in[2]) + (1-\eta_0)/(1-\eta_2) (d\xi_2/dx in[0] + d\xi_2/dy in[1] + d\xi_2/dz in[2] )) + \]

\[ (d\phi/d\eta_1, (d\xi_1/dx in[0] + d\xi_1/dy in[1] + d\xi_1/dz in[2])) + \]

\[ (d\phi/d\eta_2, (d\xi_2/dx in[0] + d\xi_2/dy in[1] + d\xi_2/dz in[2])) \]

Implements Nektar::Collections::Operator.

Definition at line 1713 of file IProductWRTDerivBase.cpp.

1718 {
1719 unsigned int nPhys = m_stdExp->GetTotPoints();
1720 unsigned int ntot = m_numElmt * nPhys;
1721 unsigned int nmodes = m_stdExp->GetNcoeffs();
1722 unsigned int nmax = max(ntot, m_numElmt * nmodes);
1723 Array<OneD, Array<OneD, const NekDouble>> in(3);
1724 Array<OneD, NekDouble> output, wsp1;
1725 Array<OneD, Array<OneD, NekDouble>> tmp(3);
1726
1727 in[0] = entry0;
1728 in[1] = entry1;
1729 in[2] = entry2;
1730
1731 output = entry3;
1732
1733 for (int i = 0; i < 3; ++i)
1734 {
1735 tmp[i] = wsp + i * nmax;
1736 }
1737
1738 if (m_isDeformed)
1739 {
1740 // calculate dx/dxi in[0] + dy/dxi in[1] + dz/dxi in[2]
1741 for (int i = 0; i < 3; ++i)
1742 {
1743 Vmath::Vmul(ntot, m_derivFac[i], 1, in[0], 1, tmp[i], 1);
1744 for (int j = 1; j < 3; ++j)
1745 {
1746 Vmath::Vvtvp(ntot, m_derivFac[i + 3 * j], 1, in[j], 1,
1747 tmp[i], 1, tmp[i], 1);
1748 }
1749 }
1750 }
1751 else
1752 {
1753 Array<OneD, NekDouble> t;
1754 for (int e = 0; e < m_numElmt; ++e)
1755 {
1756 // calculate dx/dxi in[0] + dy/dxi in[1] + dz/dxi in[2]
1757 for (int i = 0; i < 3; ++i)
1758 {
1759 Vmath::Smul(m_nqe, m_derivFac[i][e], in[0] + e * m_nqe, 1,
1760 t = tmp[i] + e * m_nqe, 1);
1761 for (int j = 1; j < 3; ++j)
1762 {
1763 Vmath::Svtvp(m_nqe, m_derivFac[i + 3 * j][e],
1764 in[j] + e * m_nqe, 1, tmp[i] + e * m_nqe,
1765 1, t = tmp[i] + e * m_nqe, 1);
1766 }
1767 }
1768 }
1769 }
1770
1771 wsp1 = wsp + 3 * nmax;
1772
1773 // Sort into eta factors
1774 for (int i = 0; i < m_numElmt; ++i)
1775 {
1776 // scale tmp[0] by fac0
1777 Vmath::Vmul(nPhys, &m_fac0[0], 1, tmp[0].get() + i * nPhys, 1,
1778 tmp[0].get() + i * nPhys, 1);
1779
1780 // scale tmp[2] by fac1 and add to tmp0
1781 Vmath::Vvtvp(nPhys, &m_fac1[0], 1, tmp[2].get() + i * nPhys, 1,
1782 tmp[0].get() + i * nPhys, 1, tmp[0].get() + i * nPhys,
1783 1);
1784 }
1785
1786 // calculate Iproduct WRT Std Deriv
1789 m_base2, m_jacWStdW, tmp[0], output, wsp1);
1790
1793 m_base2, m_jacWStdW, tmp[1], tmp[0], wsp1);
1794 Vmath::Vadd(m_numElmt * nmodes, tmp[0], 1, output, 1, output, 1);
1795
1798 m_derbase2, m_jacWStdW, tmp[2], tmp[0], wsp1);
1799 Vmath::Vadd(m_numElmt * nmodes, tmp[0], 1, output, 1, output, 1);
1800 }
void PrismIProduct(bool sortTopVert, 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:338
void Vmul(int n, const T *x, const int incx, const T *y, const int incy, T *z, const int incz)
Multiply vector z = x*y.
Definition: Vmath.hpp:72
void Svtvp(int n, const T alpha, const T *x, const int incx, const T *y, const int incy, T *z, const int incz)
Svtvp (scalar times vector plus vector): z = alpha*x + y.
Definition: Vmath.hpp:396
void Vvtvp(int n, const T *w, const int incw, const T *x, const int incx, const T *y, const int incy, T *z, const int incz)
vvtvp (vector times vector plus vector): z = w*x + y
Definition: Vmath.hpp:366
void Vadd(int n, const T *x, const int incx, const T *y, const int incy, T *z, const int incz)
Add vector z = x+y.
Definition: Vmath.hpp:180
void Smul(int n, const T alpha, const T *x, const int incx, T *y, const int incy)
Scalar multiply y = alpha*x.
Definition: Vmath.hpp:100

References m_base0, m_base1, m_base2, m_derbase0, m_derbase1, m_derbase2, m_derivFac, m_fac0, m_fac1, Nektar::Collections::Operator::m_isDeformed, m_jacWStdW, m_nmodes0, m_nmodes1, m_nmodes2, Nektar::Collections::Operator::m_nqe, m_nquad0, m_nquad1, m_nquad2, Nektar::Collections::Operator::m_numElmt, m_sortTopVertex, Nektar::Collections::Operator::m_stdExp, Nektar::Collections::PrismIProduct(), Vmath::Smul(), Vmath::Svtvp(), Vmath::Vadd(), Vmath::Vmul(), and Vmath::Vvtvp().

◆ operator()() [2/2]

void Nektar::Collections::IProductWRTDerivBase_SumFac_Prism::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 1802 of file IProductWRTDerivBase.cpp.

1806 {
1807 NEKERROR(ErrorUtil::efatal, "Not valid for this operator.");
1808 }
#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::IProductWRTDerivBase_SumFac_Prism::m_base0
protected

Definition at line 1824 of file IProductWRTDerivBase.cpp.

Referenced by operator()().

◆ m_base1

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

Definition at line 1825 of file IProductWRTDerivBase.cpp.

Referenced by operator()().

◆ m_base2

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

Definition at line 1826 of file IProductWRTDerivBase.cpp.

Referenced by operator()().

◆ m_derbase0

Array<OneD, const NekDouble> Nektar::Collections::IProductWRTDerivBase_SumFac_Prism::m_derbase0
protected

Definition at line 1827 of file IProductWRTDerivBase.cpp.

Referenced by operator()().

◆ m_derbase1

Array<OneD, const NekDouble> Nektar::Collections::IProductWRTDerivBase_SumFac_Prism::m_derbase1
protected

Definition at line 1828 of file IProductWRTDerivBase.cpp.

Referenced by operator()().

◆ m_derbase2

Array<OneD, const NekDouble> Nektar::Collections::IProductWRTDerivBase_SumFac_Prism::m_derbase2
protected

Definition at line 1829 of file IProductWRTDerivBase.cpp.

Referenced by operator()().

◆ m_derivFac

Array<TwoD, const NekDouble> Nektar::Collections::IProductWRTDerivBase_SumFac_Prism::m_derivFac
protected

Definition at line 1830 of file IProductWRTDerivBase.cpp.

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

◆ m_fac0

Array<OneD, NekDouble> Nektar::Collections::IProductWRTDerivBase_SumFac_Prism::m_fac0
protected

Definition at line 1831 of file IProductWRTDerivBase.cpp.

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

◆ m_fac1

Array<OneD, NekDouble> Nektar::Collections::IProductWRTDerivBase_SumFac_Prism::m_fac1
protected

Definition at line 1832 of file IProductWRTDerivBase.cpp.

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

◆ m_jacWStdW

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

Definition at line 1823 of file IProductWRTDerivBase.cpp.

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

◆ m_nmodes0

const int Nektar::Collections::IProductWRTDerivBase_SumFac_Prism::m_nmodes0
protected

Definition at line 1820 of file IProductWRTDerivBase.cpp.

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

◆ m_nmodes1

const int Nektar::Collections::IProductWRTDerivBase_SumFac_Prism::m_nmodes1
protected

Definition at line 1821 of file IProductWRTDerivBase.cpp.

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

◆ m_nmodes2

const int Nektar::Collections::IProductWRTDerivBase_SumFac_Prism::m_nmodes2
protected

Definition at line 1822 of file IProductWRTDerivBase.cpp.

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

◆ m_nquad0

const int Nektar::Collections::IProductWRTDerivBase_SumFac_Prism::m_nquad0
protected

Definition at line 1817 of file IProductWRTDerivBase.cpp.

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

◆ m_nquad1

const int Nektar::Collections::IProductWRTDerivBase_SumFac_Prism::m_nquad1
protected

Definition at line 1818 of file IProductWRTDerivBase.cpp.

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

◆ m_nquad2

const int Nektar::Collections::IProductWRTDerivBase_SumFac_Prism::m_nquad2
protected

Definition at line 1819 of file IProductWRTDerivBase.cpp.

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

◆ m_sortTopVertex

bool Nektar::Collections::IProductWRTDerivBase_SumFac_Prism::m_sortTopVertex
protected

Definition at line 1833 of file IProductWRTDerivBase.cpp.

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