Nektar++
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Attributes | Private Member Functions | Static Private Attributes | List of all members
Nektar::MultiRegions::PreconditionerLinear Class Reference

#include <PreconditionerLinear.h>

Inheritance diagram for Nektar::MultiRegions::PreconditionerLinear:
Inheritance graph
[legend]
Collaboration diagram for Nektar::MultiRegions::PreconditionerLinear:
Collaboration graph
[legend]

Public Member Functions

 PreconditionerLinear (const boost::shared_ptr< GlobalLinSys > &plinsys, const AssemblyMapSharedPtr &pLocToGloMap)
 
virtual ~PreconditionerLinear ()
 
- Public Member Functions inherited from Nektar::MultiRegions::Preconditioner
 Preconditioner (const boost::shared_ptr< GlobalLinSys > &plinsys, const AssemblyMapSharedPtr &pLocToGloMap)
 
virtual ~Preconditioner ()
 
void DoPreconditioner (const Array< OneD, NekDouble > &pInput, Array< OneD, NekDouble > &pOutput)
 
void DoPreconditionerWithNonVertOutput (const Array< OneD, NekDouble > &pInput, Array< OneD, NekDouble > &pOutput, const Array< OneD, NekDouble > &pNonVertOutput, Array< OneD, NekDouble > &pVertForce=NullNekDouble1DArray)
 
void DoTransformToLowEnergy (Array< OneD, NekDouble > &pInOut, int offset)
 
void DoTransformToLowEnergy (const Array< OneD, NekDouble > &pInput, Array< OneD, NekDouble > &pOutput)
 
void DoTransformFromLowEnergy (Array< OneD, NekDouble > &pInOut)
 
void DoMultiplybyInverseTransformationMatrix (const Array< OneD, NekDouble > &pInput, Array< OneD, NekDouble > &pOutput)
 
void DoMultiplybyInverseTransposedTransformationMatrix (const Array< OneD, NekDouble > &pInput, Array< OneD, NekDouble > &pOutput)
 
void BuildPreconditioner ()
 
void InitObject ()
 
Array< OneD, NekDouble > AssembleStaticCondGlobalDiagonals ()
 Performs global assembly of diagonal entries to global Schur complement matrix. More...
 
const DNekScalBlkMatSharedPtr & GetBlockTransformedSchurCompl () const
 
const DNekScalBlkMatSharedPtr & GetBlockCMatrix () const
 
const DNekScalBlkMatSharedPtr & GetBlockInvDMatrix () const
 
const DNekScalBlkMatSharedPtr & GetBlockSchurCompl () const
 
const DNekScalBlkMatSharedPtr & GetBlockTransformationMatrix () const
 
const DNekScalBlkMatSharedPtr & GetBlockTransposedTransformationMatrix () const
 
DNekScalMatSharedPtr TransformedSchurCompl (int offset, const boost::shared_ptr< DNekScalMat > &loc_mat)
 

Static Public Member Functions

static PreconditionerSharedPtr create (const boost::shared_ptr< GlobalLinSys > &plinsys, const boost::shared_ptr< AssemblyMap > &pLocToGloMap)
 Creates an instance of this class. More...
 

Static Public Attributes

static std::string className1
 Name of class. More...
 

Protected Attributes

GlobalLinSysSharedPtr m_vertLinsys
 
boost::shared_ptr< AssemblyMap > m_vertLocToGloMap
 
- Protected Attributes inherited from Nektar::MultiRegions::Preconditioner
const boost::weak_ptr
< GlobalLinSys > 		m_linsys
 
PreconditionerType m_preconType
 
DNekMatSharedPtr m_preconditioner
 
boost::shared_ptr< AssemblyMap > m_locToGloMap
 
LibUtilities::CommSharedPtr m_comm
 

Private Member Functions

virtual void v_InitObject ()
 
virtual void v_DoPreconditionerWithNonVertOutput (const Array< OneD, NekDouble > &pInput, Array< OneD, NekDouble > &pOutput, const Array< OneD, NekDouble > &pNonVertOutput, Array< OneD, NekDouble > &pVertForce)
 Apply a preconditioner to the conjugate gradient method with an output for non-vertex degrees of freedom. More...
 
virtual void v_DoPreconditioner (const Array< OneD, NekDouble > &pInput, Array< OneD, NekDouble > &pOutput)
 Apply a preconditioner to the conjugate gradient method. More...
 
virtual void v_BuildPreconditioner ()
 

Static Private Attributes

static std::string solveType
 
static std::string solveTypeIds []
 

Additional Inherited Members

- Protected Member Functions inherited from Nektar::MultiRegions::Preconditioner
virtual DNekScalMatSharedPtr v_TransformedSchurCompl (int offset, const boost::shared_ptr< DNekScalMat > &loc_mat)
 Get block elemental transposed transformation matrix $\mathbf{R}^{T}$. More...
 

Detailed Description

This class implements preconditioning for the conjugate gradient matrix solver.

Definition at line 58 of file PreconditionerLinear.h.

Constructor & Destructor Documentation

Nektar::MultiRegions::PreconditionerLinear::PreconditionerLinear ( const boost::shared_ptr< GlobalLinSys > &  plinsys,
const AssemblyMapSharedPtr &  pLocToGloMap 
)

Definition at line 88 of file PreconditionerLinear.cpp.

91  : Preconditioner(plinsys, pLocToGloMap)
92  {
93  }
Nektar::MultiRegions::Preconditioner::Preconditioner
Preconditioner(const boost::shared_ptr< GlobalLinSys > &plinsys, const AssemblyMapSharedPtr &pLocToGloMap)
Definition: Preconditioner.cpp:76
virtual Nektar::MultiRegions::PreconditionerLinear::~PreconditionerLinear ( )
inlinevirtual

Definition at line 80 of file PreconditionerLinear.h.

80 {}

Member Function Documentation

static PreconditionerSharedPtr Nektar::MultiRegions::PreconditionerLinear::create ( const boost::shared_ptr< GlobalLinSys > &  plinsys,
const boost::shared_ptr< AssemblyMap > &  pLocToGloMap 
)
inlinestatic

Creates an instance of this class.

Definition at line 62 of file PreconditionerLinear.h.

References Nektar::MemoryManager< DataType >::AllocateSharedPtr(), and CellMLToNektar.cellml_metadata::p.

66  {
67  PreconditionerSharedPtr p = MemoryManager<PreconditionerLinear>::AllocateSharedPtr(plinsys,pLocToGloMap);
68  p->InitObject();
69  return p;
70  }
Nektar::MemoryManager::AllocateSharedPtr
static boost::shared_ptr< DataType > AllocateSharedPtr()
Allocate a shared pointer from the memory pool.
Definition: NekMemoryManager.hpp:235
Nektar::MultiRegions::PreconditionerSharedPtr
boost::shared_ptr< Preconditioner > PreconditionerSharedPtr
Definition: GlobalLinSys.h:62
CellMLToNektar.cellml_metadata.p
tuple p
Definition: cellml_metadata.py:350
void Nektar::MultiRegions::PreconditionerLinear::v_BuildPreconditioner ( )
privatevirtual

Reimplemented from Nektar::MultiRegions::Preconditioner.

Definition at line 99 of file PreconditionerLinear.cpp.

References Nektar::MemoryManager< DataType >::AllocateSharedPtr(), ASSERTL0, Nektar::MultiRegions::eIterativeStaticCond, Nektar::MultiRegions::eLinearPreconPETSc, Nektar::MultiRegions::eLinearPreconXxt, Nektar::StdRegions::eMass, Nektar::MultiRegions::ePETScFullMatrix, Nektar::MultiRegions::ePETScStaticCond, Nektar::StdRegions::ePreconLinearSpace, Nektar::StdRegions::ePreconLinearSpaceMass, Nektar::MultiRegions::eXxtFullMatrix, Nektar::MultiRegions::Preconditioner::m_linsys, Nektar::MultiRegions::Preconditioner::m_locToGloMap, m_vertLinsys, m_vertLocToGloMap, and solveType.

100  {
101  GlobalSysSolnType sType = m_locToGloMap->GetGlobalSysSolnType();
102  ASSERTL0(sType == eIterativeStaticCond || sType == ePETScStaticCond,
103  "This type of preconditioning is not implemented "
104  "for this solver");
105 
106  boost::shared_ptr<MultiRegions::ExpList>
107  expList=((m_linsys.lock())->GetLocMat()).lock();
108 
109  LinearPreconSolver solveType =
110  expList->GetSession()->GetSolverInfoAsEnum<LinearPreconSolver>(
111  "LinearPreconSolver");
112 
113  GlobalSysSolnType linSolveType;
114 
115  switch(solveType)
116  {
117  case eLinearPreconPETSc:
118  {
119  linSolveType = ePETScFullMatrix;
120 #ifndef NEKTAR_USING_PETSC
121  ASSERTL0(false, "Nektar++ has not been compiled with "
122  "PETSc support.");
123 #endif
124  }
125  case eLinearPreconXxt:
126  default:
127  {
128  linSolveType = eXxtFullMatrix;
129  break;
130  }
131  }
132 
133  m_vertLocToGloMap = m_locToGloMap->LinearSpaceMap(*expList, linSolveType);
134 
135  // Generate linear solve system.
136  StdRegions::MatrixType mType =
137  m_linsys.lock()->GetKey().GetMatrixType() == StdRegions::eMass ?
138  StdRegions::ePreconLinearSpaceMass :
139  StdRegions::ePreconLinearSpace;
140 
141  GlobalLinSysKey preconKey(mType, m_vertLocToGloMap, (m_linsys.lock())->GetKey().GetConstFactors());
142 
143  switch(solveType)
144  {
145  case eLinearPreconXxt:
146  {
147  m_vertLinsys = MemoryManager<GlobalLinSysXxtFull>::
148  AllocateSharedPtr(preconKey,expList,m_vertLocToGloMap);
149  break;
150  }
151  case eLinearPreconPETSc:
152  {
153 #ifdef NEKTAR_USING_PETSC
154  m_vertLinsys = MemoryManager<GlobalLinSysPETScFull>::
155  AllocateSharedPtr(preconKey,expList,m_vertLocToGloMap);
156 #else
157  ASSERTL0(false, "Nektar++ has not been compiled with "
158  "PETSc support.");
159 #endif
160  }
161  }
162  }
Nektar::MultiRegions::Preconditioner::m_locToGloMap
boost::shared_ptr< AssemblyMap > m_locToGloMap
Definition: Preconditioner.h:137
ASSERTL0
#define ASSERTL0(condition, msg)
Definition: ErrorUtil.hpp:198
Nektar::MemoryManager::AllocateSharedPtr
static boost::shared_ptr< DataType > AllocateSharedPtr()
Allocate a shared pointer from the memory pool.
Definition: NekMemoryManager.hpp:235
Nektar::MultiRegions::PreconditionerLinear::m_vertLocToGloMap
boost::shared_ptr< AssemblyMap > m_vertLocToGloMap
Definition: PreconditionerLinear.h:84
Nektar::MultiRegions::Preconditioner::m_linsys
const boost::weak_ptr< GlobalLinSys > m_linsys
Definition: Preconditioner.h:134
void Nektar::MultiRegions::PreconditionerLinear::v_DoPreconditioner ( const Array< OneD, NekDouble > &  pInput,
Array< OneD, NekDouble > &  pOutput 
)
privatevirtual

Apply a preconditioner to the conjugate gradient method.

Reimplemented from Nektar::MultiRegions::Preconditioner.

Definition at line 167 of file PreconditionerLinear.cpp.

References Nektar::NullNekDouble1DArray, and v_DoPreconditionerWithNonVertOutput().

170  {
171  v_DoPreconditionerWithNonVertOutput(pInput,pOutput,NullNekDouble1DArray,
172  NullNekDouble1DArray);
173  }
Nektar::NullNekDouble1DArray
static Array< OneD, NekDouble > NullNekDouble1DArray
Definition: SharedArray.hpp:785
Nektar::MultiRegions::PreconditionerLinear::v_DoPreconditionerWithNonVertOutput
virtual void v_DoPreconditionerWithNonVertOutput(const Array< OneD, NekDouble > &pInput, Array< OneD, NekDouble > &pOutput, const Array< OneD, NekDouble > &pNonVertOutput, Array< OneD, NekDouble > &pVertForce)
Apply a preconditioner to the conjugate gradient method with an output for non-vertex degrees of free...
Definition: PreconditionerLinear.cpp:178
void Nektar::MultiRegions::PreconditionerLinear::v_DoPreconditionerWithNonVertOutput ( const Array< OneD, NekDouble > &  pInput,
Array< OneD, NekDouble > &  pOutput,
const Array< OneD, NekDouble > &  pNonVertOutput,
Array< OneD, NekDouble > &  pVertForce 
)
privatevirtual

Apply a preconditioner to the conjugate gradient method with an output for non-vertex degrees of freedom.

Reimplemented from Nektar::MultiRegions::Preconditioner.

Definition at line 178 of file PreconditionerLinear.cpp.

References ASSERTL0, ASSERTL1, Nektar::MultiRegions::eIterativeStaticCond, Nektar::MultiRegions::ePETScStaticCond, Nektar::MultiRegions::Preconditioner::m_locToGloMap, m_vertLinsys, m_vertLocToGloMap, Nektar::NullNekDouble1DArray, Vmath::Vcopy(), and Vmath::Zero().

Referenced by v_DoPreconditioner().

183  {
184  GlobalSysSolnType solvertype=m_locToGloMap->GetGlobalSysSolnType();
185  switch(solvertype)
186  {
187  case MultiRegions::eIterativeStaticCond:
188  case MultiRegions::ePETScStaticCond:
189  {
190  int i,val;
191  int nloc = m_vertLocToGloMap->GetNumLocalCoeffs();
192  int nglo = m_vertLocToGloMap->GetNumGlobalCoeffs();
193  // mapping from full space to vertices
194  Array<OneD, int> LocToGloBnd = m_vertLocToGloMap->GetLocalToGlobalBndMap();
195 
196  // Global to local for linear solver (different from above)
197  Array<OneD, int> LocToGlo = m_vertLocToGloMap->GetLocalToGlobalMap();
198 
199  // number of Dir coeffs in from full problem
200  int nDirFull = m_locToGloMap->GetNumGlobalDirBndCoeffs();
201 
202  Array<OneD,NekDouble> In(nglo,0.0);
203  Array<OneD,NekDouble> Out(nglo,0.0);
204 
205  // Gather rhs
206  for(i = 0; i < nloc; ++i)
207  {
208  val = LocToGloBnd[i];
209  if(val >= nDirFull)
210  {
211  In[LocToGlo[i]] = pInput[val-nDirFull];
212  }
213  }
214 
215  // Do solve without enforcing any boundary conditions.
216  m_vertLinsys->SolveLinearSystem(
217  m_vertLocToGloMap->GetNumGlobalCoeffs(),
218  In,Out,m_vertLocToGloMap,
219  m_vertLocToGloMap->GetNumGlobalDirBndCoeffs());
220 
221 
222  if(pNonVertOutput != NullNekDouble1DArray)
223  {
224  ASSERTL1(pNonVertOutput.num_elements() >= pOutput.num_elements(),"Non Vert output is not of sufficient length");
225  Vmath::Vcopy(pOutput.num_elements(),pNonVertOutput,1,pOutput,1);
226  }
227  else
228  {
229  //Copy input to output as a unit preconditioner on
230  //any other value
231  Vmath::Vcopy(pInput.num_elements(),pInput,1,pOutput,1);
232  }
233 
234  if(pVertForce != NullNekDouble1DArray)
235  {
236  Vmath::Zero(pVertForce.num_elements(),pVertForce,1);
237  // Scatter back soln from linear solve
238  for(i = 0; i < nloc; ++i)
239  {
240  val = LocToGloBnd[i];
241  if(val >= nDirFull)
242  {
243  pOutput[val-nDirFull] = Out[LocToGlo[i]];
244  // copy vertex forcing into this vector
245  pVertForce[val-nDirFull] = In[LocToGlo[i]];
246  }
247  }
248  }
249  else
250  {
251  // Scatter back soln from linear solve
252  for(i = 0; i < nloc; ++i)
253  {
254  val = LocToGloBnd[i];
255  if(val >= nDirFull)
256  {
257  pOutput[val-nDirFull] = Out[LocToGlo[i]];
258  }
259  }
260  }
261  }
262  break;
263  default:
264  ASSERTL0(0,"Unsupported solver type");
265  break;
266  }
267  }
Nektar::MultiRegions::Preconditioner::m_locToGloMap
boost::shared_ptr< AssemblyMap > m_locToGloMap
Definition: Preconditioner.h:137
ASSERTL0
#define ASSERTL0(condition, msg)
Definition: ErrorUtil.hpp:198
Nektar::NullNekDouble1DArray
static Array< OneD, NekDouble > NullNekDouble1DArray
Definition: SharedArray.hpp:785
Nektar::MultiRegions::PreconditionerLinear::m_vertLocToGloMap
boost::shared_ptr< AssemblyMap > m_vertLocToGloMap
Definition: PreconditionerLinear.h:84
Vmath::Zero
void Zero(int n, T *x, const int incx)
Zero vector.
Definition: Vmath.cpp:373
ASSERTL1
#define ASSERTL1(condition, msg)
Assert Level 1 – Debugging which is used whether in FULLDEBUG or DEBUG compilation mode...
Definition: ErrorUtil.hpp:228
Vmath::Vcopy
void Vcopy(int n, const T *x, const int incx, T *y, const int incy)
Definition: Vmath.cpp:1061
void Nektar::MultiRegions::PreconditionerLinear::v_InitObject ( )
privatevirtual

Reimplemented from Nektar::MultiRegions::Preconditioner.

Definition at line 95 of file PreconditionerLinear.cpp.

96  {
97  }

Member Data Documentation

string Nektar::MultiRegions::PreconditionerLinear::className1
static
Initial value:
= GetPreconFactory().RegisterCreatorFunction(
"FullLinearSpace",
PreconditionerLinear::create,
"Full Linear space inverse Preconditioning")

Name of class.

Registers the class with the Factory.

Definition at line 73 of file PreconditionerLinear.h.

GlobalLinSysSharedPtr Nektar::MultiRegions::PreconditionerLinear::m_vertLinsys
protected

Definition at line 83 of file PreconditionerLinear.h.

Referenced by v_BuildPreconditioner(), and v_DoPreconditionerWithNonVertOutput().

boost::shared_ptr<AssemblyMap> Nektar::MultiRegions::PreconditionerLinear::m_vertLocToGloMap
protected

Definition at line 84 of file PreconditionerLinear.h.

Referenced by v_BuildPreconditioner(), and v_DoPreconditionerWithNonVertOutput().

std::string Nektar::MultiRegions::PreconditionerLinear::solveType
staticprivate
Initial value:
=
LibUtilities::SessionReader::RegisterDefaultSolverInfo(
"LinearPreconSolver",
"Xxt")

Definition at line 87 of file PreconditionerLinear.h.

Referenced by v_BuildPreconditioner().

std::string Nektar::MultiRegions::PreconditionerLinear::solveTypeIds
staticprivate
Initial value:
= {
LibUtilities::SessionReader::RegisterEnumValue(
"LinearPreconSolver",
"PETSc",
MultiRegions::eLinearPreconPETSc),
LibUtilities::SessionReader::RegisterEnumValue(
"LinearPreconSolver",
"Xxt",
MultiRegions::eLinearPreconXxt)
}

Definition at line 88 of file PreconditionerLinear.h.

Generated on Sat Nov 25 2017 16:19:02 for Nektar++ by   doxygen 1.8.8