Nektar++
Loading...
Searching...
No Matches
Protected Member Functions | Protected Attributes | List of all members
Nektar::SolverUtils::DriverParallelInTime Class Reference

Base class for the development of parallel-in-time solvers. More...

#include <DriverParallelInTime.h>

Inheritance diagram for Nektar::SolverUtils::DriverParallelInTime:
[legend]

Protected Member Functions

SOLVER_UTILS_EXPORT DriverParallelInTime (const LibUtilities::SessionReaderSharedPtr pSession, const SpatialDomains::MeshGraphSharedPtr pGraph)
 Constructor.
 
SOLVER_UTILS_EXPORT ~DriverParallelInTime () override=default
 Destructor.
 
SOLVER_UTILS_EXPORT void v_InitObject (std::ostream &out=std::cout) override
 Virtual function for initialisation implementation.
 
SOLVER_UTILS_EXPORT void v_Execute (std::ostream &out=std::cout) override
 Virtual function for solve implementation.
 
void SetParallelInTimeEquationSystem (std::string AdvectiveType)
 
void GetParametersFromSession (void)
 
void InitialiseEqSystem (bool turnoff_output)
 
void InitialiseInterpolationField (void)
 
void PrintSolverInfo (std::ostream &out=std::cout)
 
void PrintHeader (const std::string &title, const char c)
 
void RecvFromPreviousProc (Array< OneD, Array< OneD, NekDouble > > &array, int &convergence)
 
void RecvFromPreviousProc (Array< OneD, NekDouble > &array)
 
void SendToNextProc (Array< OneD, Array< OneD, NekDouble > > &array, int &convergence)
 
void SendToNextProc (Array< OneD, NekDouble > &array)
 
void CopySolutionVector (const Array< OneD, const Array< OneD, NekDouble > > &in, Array< OneD, Array< OneD, NekDouble > > &out)
 
void CopyFromPhysField (const size_t timeLevel, Array< OneD, Array< OneD, NekDouble > > &out)
 
void CopyToPhysField (const size_t timeLevel, const Array< OneD, const Array< OneD, NekDouble > > &in)
 
void UpdateFieldCoeffs (const size_t timeLevel, const Array< OneD, const Array< OneD, NekDouble > > &in=NullNekDoubleArrayOfArray)
 
void EvaluateExactSolution (const size_t timeLevel, const NekDouble &time)
 
void SolutionConvergenceMonitoring (const size_t timeLevel, const size_t iter)
 
void SolutionConvergenceSummary (const size_t timeLevel)
 
void UpdateErrorNorm (const size_t timeLevel, const bool normalized)
 
void PrintErrorNorm (const size_t timeLevel, const bool normalized)
 
NekDouble vL2ErrorMax (void)
 
NekDouble EstimateCommunicationTime (Array< OneD, Array< OneD, NekDouble > > &buffer1, Array< OneD, Array< OneD, NekDouble > > &buffer2)
 
void Interpolate (const Array< OneD, MultiRegions::ExpListSharedPtr > &infield, const Array< OneD, MultiRegions::ExpListSharedPtr > &outfield, const Array< OneD, Array< OneD, NekDouble > > &inarray, Array< OneD, Array< OneD, NekDouble > > &outarray)
 
- Protected Member Functions inherited from Nektar::SolverUtils::Driver
 Driver (const LibUtilities::SessionReaderSharedPtr pSession, const SpatialDomains::MeshGraphSharedPtr pGraph)
 Initialises EquationSystem class members.
 

Protected Attributes

NekDouble m_totalTime
 Total time integration interval.
 
NekDouble m_chunkTime
 Time integration interval per chunk.
 
NekDouble m_time
 Local time.
 
NekDouble m_time0
 
size_t m_numChunks
 Number of time chunks.
 
size_t m_chunkRank
 Rank in time.
 
size_t m_iterMaxPIT
 Maximum number of parallel-in-time iteration.
 
size_t m_numWindowsPIT
 
bool m_exactSolution
 Using exact solution to compute error norms.
 
NekDouble m_tolerPIT
 ParallelInTime tolerance.
 
size_t m_nVar
 Number of variables.
 
size_t m_nTimeLevel
 Number of time levels.
 
Array< OneD, size_t > m_nsteps
 Number of time steps for each time level.
 
Array< OneD, NekDoublem_timestep
 Time step for each time level.
 
Array< OneD, size_t > m_npts
 Number of dof for each time level.
 
Array< OneD, std::shared_ptr< UnsteadySystem > > m_EqSys
 Equation system to solve.
 
Array< OneD, NekDoublem_vL2Errors
 Storage for parallel-in-time iteration.
 
Array< OneD, NekDoublem_vLinfErrors
 
Array< OneD, Array< OneD, NekDouble > > m_exactsoln
 
- Protected Attributes inherited from Nektar::SolverUtils::Driver
LibUtilities::CommSharedPtr m_comm
 Communication object.
 
LibUtilities::SessionReaderSharedPtr m_session
 Session reader object.
 
LibUtilities::SessionReaderSharedPtr session_LinNS
 Coupling between SFD and arnoldi.
 
SpatialDomains::MeshGraphSharedPtr m_graph
 MeshGraph object.
 
Array< OneD, EquationSystemSharedPtrm_equ
 Equation system to solve.
 
int m_nequ
 number of equations
 
enum EvolutionOperatorType m_EvolutionOperator
 Evolution Operator.
 

Additional Inherited Members

- Public Member Functions inherited from Nektar::SolverUtils::Driver
virtual ~Driver ()=default
 Destructor.
 
SOLVER_UTILS_EXPORT void InitObject (std::ostream &out=std::cout)
 Initialise Object.
 
SOLVER_UTILS_EXPORT void Execute (std::ostream &out=std::cout)
 Execute driver.
 
SOLVER_UTILS_EXPORT Array< OneD, EquationSystemSharedPtrGetEqu ()
 
- Static Protected Attributes inherited from Nektar::SolverUtils::Driver
static std::string evolutionOperatorLookupIds []
 
static std::string evolutionOperatorDef
 
static std::string driverDefault
 

Detailed Description

Base class for the development of parallel-in-time solvers.

Definition at line 45 of file DriverParallelInTime.h.

Constructor & Destructor Documentation

◆ DriverParallelInTime()

Nektar::SolverUtils::DriverParallelInTime::DriverParallelInTime ( const LibUtilities::SessionReaderSharedPtr  pSession,
const SpatialDomains::MeshGraphSharedPtr  pGraph 
)
protected

Constructor.

Definition at line 55 of file DriverParallelInTime.cpp.

58 : Driver(pSession, pGraph)
59{
60}
Driver(const LibUtilities::SessionReaderSharedPtr pSession, const SpatialDomains::MeshGraphSharedPtr pGraph)
Initialises EquationSystem class members.
Definition Driver.cpp:73

◆ ~DriverParallelInTime()

SOLVER_UTILS_EXPORT Nektar::SolverUtils::DriverParallelInTime::~DriverParallelInTime ( )
overrideprotecteddefault

Destructor.

Member Function Documentation

◆ CopyFromPhysField()

void Nektar::SolverUtils::DriverParallelInTime::CopyFromPhysField ( const size_t  timeLevel,
Array< OneD, Array< OneD, NekDouble > > &  out 
)
protected

Definition at line 429 of file DriverParallelInTime.cpp.

431{
432 for (size_t i = 0; i < m_nVar; ++i)
433 {
434 m_EqSys[timeLevel]->CopyFromPhysField(i, out[i]);
435 }
436}
Array< OneD, std::shared_ptr< UnsteadySystem > > m_EqSys
Equation system to solve.

References m_EqSys, and m_nVar.

Referenced by Nektar::SolverUtils::DriverParareal::v_Execute().

◆ CopySolutionVector()

void Nektar::SolverUtils::DriverParallelInTime::CopySolutionVector ( const Array< OneD, const Array< OneD, NekDouble > > &  in,
Array< OneD, Array< OneD, NekDouble > > &  out 
)
protected

Definition at line 416 of file DriverParallelInTime.cpp.

419{
420 for (size_t i = 0; i < m_nVar; ++i)
421 {
422 Vmath::Vcopy(in[i].size(), in[i], 1, out[i], 1);
423 }
424}
void Vcopy(int n, const T *x, const int incx, T *y, const int incy)
Definition Vmath.hpp:825

References m_nVar, and Vmath::Vcopy().

Referenced by Nektar::SolverUtils::DriverPFASST::RestrictResidual(), and Nektar::SolverUtils::DriverPFASST::RestrictSolution().

◆ CopyToPhysField()

void Nektar::SolverUtils::DriverParallelInTime::CopyToPhysField ( const size_t  timeLevel,
const Array< OneD, const Array< OneD, NekDouble > > &  in 
)
protected

Definition at line 441 of file DriverParallelInTime.cpp.

443{
444 for (size_t i = 0; i < m_nVar; ++i)
445 {
446 m_EqSys[timeLevel]->CopyToPhysField(i, in[i]);
447 m_EqSys[timeLevel]->UpdateFields()[i]->SetPhysState(true);
448 }
449}

References m_EqSys, and m_nVar.

Referenced by Nektar::SolverUtils::DriverParareal::v_Execute().

◆ EstimateCommunicationTime()

NekDouble Nektar::SolverUtils::DriverParallelInTime::EstimateCommunicationTime ( Array< OneD, Array< OneD, NekDouble > > &  buffer1,
Array< OneD, Array< OneD, NekDouble > > &  buffer2 
)
protected

Definition at line 568 of file DriverParallelInTime.cpp.

571{
572 if (m_numChunks == 1)
573 {
574 return 0.0;
575 }
576 else
577 {
578 // Average communication time over niter iteration.
579 size_t niter = 20;
581 for (size_t n = 0; n <= niter; n++)
582 {
583 if (n == 1)
584 {
585 timer.Start(); // Ignore the first iteration
586 }
587
588 if (m_chunkRank == 0)
589 {
590 for (size_t i = 0; i < buffer1.size(); ++i)
591 {
592 m_comm->GetTimeComm()->Send(m_numChunks - 1, buffer1[i]);
593 }
594 }
595
596 if (m_chunkRank == m_numChunks - 1)
597 {
598 for (size_t i = 0; i < buffer2.size(); ++i)
599 {
600 m_comm->GetTimeComm()->Recv(0, buffer2[i]);
601 }
602 }
603 }
604 timer.Stop();
605 return timer.Elapsed().count() / niter;
606 }
607}
LibUtilities::CommSharedPtr m_comm
Communication object.
Definition Driver.h:80

References Nektar::LibUtilities::Timer::Elapsed(), m_chunkRank, Nektar::SolverUtils::Driver::m_comm, m_numChunks, Nektar::LibUtilities::Timer::Start(), and Nektar::LibUtilities::Timer::Stop().

◆ EvaluateExactSolution()

void Nektar::SolverUtils::DriverParallelInTime::EvaluateExactSolution ( const size_t  timeLevel,
const NekDouble time 
)
protected

Definition at line 472 of file DriverParallelInTime.cpp.

474{
475 for (size_t i = 0; i < m_nVar; ++i)
476 {
477 m_EqSys[timeLevel]->EvaluateExactSolution(i, m_exactsoln[i], time);
478 }
479}
Array< OneD, Array< OneD, NekDouble > > m_exactsoln

References m_EqSys, m_exactsoln, and m_nVar.

Referenced by Nektar::SolverUtils::DriverParareal::v_Execute(), and Nektar::SolverUtils::DriverPFASST::v_Execute().

◆ GetParametersFromSession()

void Nektar::SolverUtils::DriverParallelInTime::GetParametersFromSession ( void  )
protected

Definition at line 251 of file DriverParallelInTime.cpp.

252{
253 // Parallel-in-Time iteration parameters.
254 m_tolerPIT = m_session->DefinesParameter("PITToler")
255 ? m_session->GetParameter("PITToler")
256 : 1.0E-16;
257 m_iterMaxPIT = m_session->DefinesParameter("PITIterMax")
258 ? m_session->GetParameter("PITIterMax")
259 : m_numChunks;
260 m_numWindowsPIT = m_session->DefinesParameter("NumWindows")
261 ? m_session->GetParameter("NumWindows")
262 : 1;
263
264 // Other parameters.
265 m_exactSolution = m_session->DefinesParameter("ExactSolution")
266 ? m_session->GetParameter("ExactSolution")
267 : 0;
268}
LibUtilities::SessionReaderSharedPtr m_session
Session reader object.
Definition Driver.h:83
size_t m_iterMaxPIT
Maximum number of parallel-in-time iteration.
NekDouble m_tolerPIT
ParallelInTime tolerance.
bool m_exactSolution
Using exact solution to compute error norms.

References m_exactSolution, m_iterMaxPIT, m_numChunks, m_numWindowsPIT, Nektar::SolverUtils::Driver::m_session, and m_tolerPIT.

Referenced by Nektar::SolverUtils::DriverParareal::v_InitObject(), and Nektar::SolverUtils::DriverPFASST::v_InitObject().

◆ InitialiseEqSystem()

void Nektar::SolverUtils::DriverParallelInTime::InitialiseEqSystem ( bool  turnoff_output)
protected

Definition at line 273 of file DriverParallelInTime.cpp.

274{
275 m_nVar = m_EqSys[0]->GetNvariables();
276
277 // Initialize fine solver.
278 if (turnoff_output)
279 {
280 for (size_t timeLevel = 0; timeLevel < m_nTimeLevel; timeLevel++)
281 {
282 m_EqSys[timeLevel]->SetInfoSteps(0);
283 m_EqSys[timeLevel]->SetCheckpointSteps(0);
284 }
285 }
286 m_EqSys[0]->DoInitialise(true);
287
288 // Initialize coarse solver(s).
289 for (size_t timeLevel = 1; timeLevel < m_nTimeLevel; timeLevel++)
290 {
291 m_EqSys[timeLevel]->DoInitialise(false);
292 }
293
294 // Initialize time stepping parameters.
295 m_time0 = m_EqSys[0]->GetTime();
296 m_timestep = Array<OneD, NekDouble>(m_nTimeLevel);
297 m_nsteps = Array<OneD, size_t>(m_nTimeLevel);
298 m_npts = Array<OneD, size_t>(m_nTimeLevel);
299 for (size_t timeLevel = 0; timeLevel < m_nTimeLevel; timeLevel++)
300 {
301 m_timestep[timeLevel] =
302 m_EqSys[timeLevel]->EquationSystem::GetTimeStep();
303 m_nsteps[timeLevel] = m_EqSys[timeLevel]->EquationSystem::GetSteps();
304 m_npts[timeLevel] = m_EqSys[timeLevel]->EquationSystem::GetNpoints();
305 }
306
307 // Initialize errors.
308 m_exactsoln = Array<OneD, Array<OneD, NekDouble>>(m_nVar);
309 for (size_t i = 0; i < m_nVar; ++i)
310 {
311 m_exactsoln[i] = Array<OneD, NekDouble>(m_npts[0], 0.0);
312 }
313 m_vL2Errors = Array<OneD, NekDouble>(m_nVar, 0.0);
314 m_vLinfErrors = Array<OneD, NekDouble>(m_nVar, 0.0);
315}
Array< OneD, NekDouble > m_vL2Errors
Storage for parallel-in-time iteration.
Array< OneD, size_t > m_nsteps
Number of time steps for each time level.
Array< OneD, size_t > m_npts
Number of dof for each time level.
Array< OneD, NekDouble > m_timestep
Time step for each time level.

References m_EqSys, m_exactsoln, m_npts, m_nsteps, m_nTimeLevel, m_nVar, m_time0, m_timestep, m_vL2Errors, and m_vLinfErrors.

Referenced by Nektar::SolverUtils::DriverParareal::v_InitObject(), and Nektar::SolverUtils::DriverPFASST::v_InitObject().

◆ InitialiseInterpolationField()

void Nektar::SolverUtils::DriverParallelInTime::InitialiseInterpolationField ( void  )
protected

◆ Interpolate()

void Nektar::SolverUtils::DriverParallelInTime::Interpolate ( const Array< OneD, MultiRegions::ExpListSharedPtr > &  infield,
const Array< OneD, MultiRegions::ExpListSharedPtr > &  outfield,
const Array< OneD, Array< OneD, NekDouble > > &  inarray,
Array< OneD, Array< OneD, NekDouble > > &  outarray 
)
protected

Definition at line 612 of file DriverParallelInTime.cpp.

617{
618 if (infield.size() != outfield.size())
619 {
620 NEKERROR(ErrorUtil::efatal, "not the same number of variables")
621 }
622
623 for (size_t n = 0; n < infield.size(); ++n)
624 {
625 // Interpolation from infield -> outfield assuming that infield and
626 // outfield are the same explists, but at potentially different
627 // polynomial orders.
628 if (infield[n]->GetExpSize() != outfield[n]->GetExpSize())
629 {
630 NEKERROR(ErrorUtil::efatal, "not the same mesh")
631 }
632
633 // Assign input/output array.
634 auto inphys = (inarray == NullNekDoubleArrayOfArray)
635 ? infield[n]->UpdatePhys()
636 : inarray[n];
637 auto outphys = (outarray == NullNekDoubleArrayOfArray)
638 ? outfield[n]->UpdatePhys()
639 : outarray[n];
640
641 // If same polynomial orders, simply copy solution.
642 if (infield[n]->GetTotPoints() == outfield[n]->GetTotPoints())
643 {
644 Vmath::Vcopy(infield[n]->GetTotPoints(), inphys, 1, outphys, 1);
645 }
646 // If different polynomial orders, interpolate solution.
647 else
648 {
649 for (size_t i = 0; i < infield[n]->GetExpSize(); ++i)
650 {
651 // Get the elements.
652 auto inElmt = infield[n]->GetExp(i);
653 auto outElmt = outfield[n]->GetExp(i);
654
655 // Get the offset of elements in the storage arrays.
656 size_t inoffset = infield[n]->GetPhys_Offset(i);
657 size_t outoffset = outfield[n]->GetPhys_Offset(i);
658
659 // Transform solution from physical to coefficient space.
660 Array<OneD, NekDouble> incoeff(inElmt->GetNcoeffs());
661 inElmt->FwdTrans(inphys + inoffset, incoeff);
662
663 // Interpolate elements.
665 if (inElmt->DetShapeType() == LibUtilities::Seg)
666 {
667 expPtr = std::make_shared<StdRegions::StdSegExp>(
668 LibUtilities::BasisKey(
669 inElmt->GetBasis(0)->GetBasisType(),
670 inElmt->GetBasis(0)->GetNumModes(),
671 outElmt->GetBasis(0)->GetPointsKey()));
672 }
673 else if (inElmt->DetShapeType() == LibUtilities::Quad)
674 {
675 expPtr = std::make_shared<StdRegions::StdQuadExp>(
676 LibUtilities::BasisKey(
677 inElmt->GetBasis(0)->GetBasisType(),
678 inElmt->GetBasis(0)->GetNumModes(),
679 outElmt->GetBasis(0)->GetPointsKey()),
680 LibUtilities::BasisKey(
681 inElmt->GetBasis(1)->GetBasisType(),
682 inElmt->GetBasis(1)->GetNumModes(),
683 outElmt->GetBasis(1)->GetPointsKey()));
684 }
685 else if (inElmt->DetShapeType() == LibUtilities::Tri)
686 {
687 expPtr = std::make_shared<StdRegions::StdTriExp>(
688 LibUtilities::BasisKey(
689 inElmt->GetBasis(0)->GetBasisType(),
690 inElmt->GetBasis(0)->GetNumModes(),
691 outElmt->GetBasis(0)->GetPointsKey()),
692 LibUtilities::BasisKey(
693 inElmt->GetBasis(1)->GetBasisType(),
694 inElmt->GetBasis(1)->GetNumModes(),
695 outElmt->GetBasis(1)->GetPointsKey()));
696 }
697 else if (inElmt->DetShapeType() == LibUtilities::Hex)
698 {
699 expPtr = std::make_shared<StdRegions::StdHexExp>(
700 LibUtilities::BasisKey(
701 inElmt->GetBasis(0)->GetBasisType(),
702 inElmt->GetBasis(0)->GetNumModes(),
703 outElmt->GetBasis(0)->GetPointsKey()),
704 LibUtilities::BasisKey(
705 inElmt->GetBasis(1)->GetBasisType(),
706 inElmt->GetBasis(1)->GetNumModes(),
707 outElmt->GetBasis(1)->GetPointsKey()),
708 LibUtilities::BasisKey(
709 inElmt->GetBasis(2)->GetBasisType(),
710 inElmt->GetBasis(2)->GetNumModes(),
711 outElmt->GetBasis(2)->GetPointsKey()));
712 }
713 else if (inElmt->DetShapeType() == LibUtilities::Prism)
714 {
715 expPtr = std::make_shared<StdRegions::StdPrismExp>(
716 LibUtilities::BasisKey(
717 inElmt->GetBasis(0)->GetBasisType(),
718 inElmt->GetBasis(0)->GetNumModes(),
719 outElmt->GetBasis(0)->GetPointsKey()),
720 LibUtilities::BasisKey(
721 inElmt->GetBasis(1)->GetBasisType(),
722 inElmt->GetBasis(1)->GetNumModes(),
723 outElmt->GetBasis(1)->GetPointsKey()),
724 LibUtilities::BasisKey(
725 inElmt->GetBasis(2)->GetBasisType(),
726 inElmt->GetBasis(2)->GetNumModes(),
727 outElmt->GetBasis(2)->GetPointsKey()));
728 }
729 else if (inElmt->DetShapeType() == LibUtilities::Pyr)
730 {
731 expPtr = std::make_shared<StdRegions::StdPyrExp>(
732 LibUtilities::BasisKey(
733 inElmt->GetBasis(0)->GetBasisType(),
734 inElmt->GetBasis(0)->GetNumModes(),
735 outElmt->GetBasis(0)->GetPointsKey()),
736 LibUtilities::BasisKey(
737 inElmt->GetBasis(1)->GetBasisType(),
738 inElmt->GetBasis(1)->GetNumModes(),
739 outElmt->GetBasis(1)->GetPointsKey()),
740 LibUtilities::BasisKey(
741 inElmt->GetBasis(2)->GetBasisType(),
742 inElmt->GetBasis(2)->GetNumModes(),
743 outElmt->GetBasis(2)->GetPointsKey()));
744 }
745 else if (inElmt->DetShapeType() == LibUtilities::Tet)
746 {
747 expPtr = std::make_shared<StdRegions::StdTetExp>(
748 LibUtilities::BasisKey(
749 inElmt->GetBasis(0)->GetBasisType(),
750 inElmt->GetBasis(0)->GetNumModes(),
751 outElmt->GetBasis(0)->GetPointsKey()),
752 LibUtilities::BasisKey(
753 inElmt->GetBasis(1)->GetBasisType(),
754 inElmt->GetBasis(1)->GetNumModes(),
755 outElmt->GetBasis(1)->GetPointsKey()),
756 LibUtilities::BasisKey(
757 inElmt->GetBasis(2)->GetBasisType(),
758 inElmt->GetBasis(2)->GetNumModes(),
759 outElmt->GetBasis(2)->GetPointsKey()));
760 }
761
762 // Transform solution from coefficient to physical space.
763 Array<OneD, NekDouble> tmp = outphys + outoffset;
764 expPtr->BwdTrans(incoeff, tmp);
765 }
766 }
767 }
768}
#define NEKERROR(type, msg)
Assert Level 0 – Fundamental assert which is used whether in FULLDEBUG, DEBUG or OPT compilation mode...
std::shared_ptr< StdExpansion > StdExpansionSharedPtr
static Array< OneD, Array< OneD, NekDouble > > NullNekDoubleArrayOfArray

References Nektar::ErrorUtil::efatal, Nektar::LibUtilities::Hex, NEKERROR, Nektar::NullNekDoubleArrayOfArray, Nektar::LibUtilities::Prism, Nektar::LibUtilities::Pyr, Nektar::LibUtilities::Quad, Nektar::LibUtilities::Seg, Nektar::LibUtilities::Tet, Nektar::LibUtilities::Tri, and Vmath::Vcopy().

Referenced by Nektar::SolverUtils::DriverParareal::InterpolateCoarseSolution(), Nektar::SolverUtils::DriverParareal::UpdateInitialConditionFromSolver(), and Nektar::SolverUtils::DriverParareal::UpdateSolverInitialCondition().

◆ PrintErrorNorm()

void Nektar::SolverUtils::DriverParallelInTime::PrintErrorNorm ( const size_t  timeLevel,
const bool  normalized 
)
protected

Definition at line 518 of file DriverParallelInTime.cpp.

520{
521 if (m_chunkRank == m_numChunks - 1 &&
522 m_comm->GetSpaceComm()->GetRank() == 0)
523 {
524 for (size_t i = 0; i < m_nVar; ++i)
525 {
526 if (normalized)
527 {
528 std::cout << "L2 error (variable "
529 << m_EqSys[timeLevel]->GetVariable(i)
530 << ") : " << m_vL2Errors[i] << std::endl
531 << std::flush;
532 std::cout << "Linf error (variable "
533 << m_EqSys[timeLevel]->GetVariable(i)
534 << ") : " << m_vLinfErrors[i] << std::endl
535 << std::flush;
536 }
537 else
538 {
539 std::cout << "L 2 error (variable "
540 << m_EqSys[timeLevel]->GetVariable(i)
541 << ") : " << m_vL2Errors[i] << std::endl
542 << std::flush;
543 std::cout << "L inf error (variable "
544 << m_EqSys[timeLevel]->GetVariable(i)
545 << ") : " << m_vLinfErrors[i] << std::endl
546 << std::flush;
547 }
548 }
549 }
550}

References m_chunkRank, Nektar::SolverUtils::Driver::m_comm, m_EqSys, m_numChunks, m_nVar, m_vL2Errors, and m_vLinfErrors.

Referenced by SolutionConvergenceMonitoring(), SolutionConvergenceSummary(), and Nektar::SolverUtils::DriverPFASST::v_Execute().

◆ PrintHeader()

void Nektar::SolverUtils::DriverParallelInTime::PrintHeader ( const std::string &  title,
const char  c 
)
protected

Definition at line 344 of file DriverParallelInTime.cpp.

345{
346 if (m_chunkRank == m_numChunks - 1 &&
347 m_comm->GetSpaceComm()->GetRank() == 0)
348 {
349 std::cout << std::endl;
350 std::cout << std::string(43, c) << std::endl << std::flush;
351 std::cout << title << std::endl << std::flush;
352 std::cout << std::string(43, c) << std::endl << std::flush;
353 }
354}

References m_chunkRank, Nektar::SolverUtils::Driver::m_comm, and m_numChunks.

Referenced by SolutionConvergenceMonitoring(), Nektar::SolverUtils::DriverParareal::v_Execute(), Nektar::SolverUtils::DriverPFASST::v_Execute(), and Nektar::SolverUtils::DriverParareal::WriteTimeChunkOuput().

◆ PrintSolverInfo()

void Nektar::SolverUtils::DriverParallelInTime::PrintSolverInfo ( std::ostream &  out = std::cout)
protected

Definition at line 320 of file DriverParallelInTime.cpp.

321{
322 if (m_chunkRank == 0 && m_comm->GetSpaceComm()->GetRank() == 0)
323 {
324 for (size_t timeLevel = 0; timeLevel < m_nTimeLevel; timeLevel++)
325 {
326 std::cout << std::string(71, '=') << std::endl << std::flush;
327 std::cout << "=========================== TIME LEVEL " +
328 std::to_string(timeLevel) +
329 " INFO "
330 "========================="
331 << std::endl
332 << std::flush;
333
334 m_EqSys[timeLevel]->PrintSummary(out);
335
336 std::cout << std::endl << std::flush;
337 }
338 }
339}

References m_chunkRank, Nektar::SolverUtils::Driver::m_comm, m_EqSys, and m_nTimeLevel.

Referenced by Nektar::SolverUtils::DriverParareal::v_InitObject(), and Nektar::SolverUtils::DriverPFASST::v_InitObject().

◆ RecvFromPreviousProc() [1/2]

void Nektar::SolverUtils::DriverParallelInTime::RecvFromPreviousProc ( Array< OneD, Array< OneD, NekDouble > > &  array,
int &  convergence 
)
protected

Definition at line 359 of file DriverParallelInTime.cpp.

361{
362 if (m_chunkRank > 0)
363 {
364 if (!convergence)
365 {
366 m_comm->GetTimeComm()->Recv(m_chunkRank - 1, convergence);
367 for (size_t i = 0; i < m_nVar; ++i)
368 {
369 m_comm->GetTimeComm()->Recv(m_chunkRank - 1, array[i]);
370 }
371 }
372 }
373}

References m_chunkRank, Nektar::SolverUtils::Driver::m_comm, and m_nVar.

Referenced by Nektar::SolverUtils::DriverParareal::v_Execute(), and Nektar::SolverUtils::DriverPFASST::v_Execute().

◆ RecvFromPreviousProc() [2/2]

void Nektar::SolverUtils::DriverParallelInTime::RecvFromPreviousProc ( Array< OneD, NekDouble > &  array)
protected

Definition at line 378 of file DriverParallelInTime.cpp.

379{
380 if (m_chunkRank > 0)
381 {
382 m_comm->GetTimeComm()->Recv(m_chunkRank - 1, array);
383 }
384}

References m_chunkRank, and Nektar::SolverUtils::Driver::m_comm.

◆ SendToNextProc() [1/2]

void Nektar::SolverUtils::DriverParallelInTime::SendToNextProc ( Array< OneD, Array< OneD, NekDouble > > &  array,
int &  convergence 
)
protected

Definition at line 389 of file DriverParallelInTime.cpp.

391{
392 if (m_chunkRank < m_numChunks - 1)
393 {
394 m_comm->GetTimeComm()->Send(m_chunkRank + 1, convergence);
395 for (size_t i = 0; i < m_nVar; ++i)
396 {
397 m_comm->GetTimeComm()->Send(m_chunkRank + 1, array[i]);
398 }
399 }
400}

References m_chunkRank, Nektar::SolverUtils::Driver::m_comm, m_numChunks, and m_nVar.

Referenced by Nektar::SolverUtils::DriverParareal::v_Execute(), and Nektar::SolverUtils::DriverPFASST::v_Execute().

◆ SendToNextProc() [2/2]

void Nektar::SolverUtils::DriverParallelInTime::SendToNextProc ( Array< OneD, NekDouble > &  array)
protected

Definition at line 405 of file DriverParallelInTime.cpp.

406{
407 if (m_chunkRank < m_numChunks - 1)
408 {
409 m_comm->GetTimeComm()->Send(m_chunkRank + 1, array);
410 }
411}

References m_chunkRank, Nektar::SolverUtils::Driver::m_comm, and m_numChunks.

◆ SetParallelInTimeEquationSystem()

void Nektar::SolverUtils::DriverParallelInTime::SetParallelInTimeEquationSystem ( std::string  AdvectiveType)
protected

Set the ParallelInTime (coarse solver) session file

Definition at line 127 of file DriverParallelInTime.cpp.

129{
130 // Retrieve the equation system to solve.
131 ASSERTL0(m_session->DefinesSolverInfo("EqType"),
132 "EqType SolverInfo tag must be defined.");
133 std::string vEquation = m_session->DefinesSolverInfo("SolverType")
134 ? m_session->GetSolverInfo("SolverType")
135 : m_session->GetSolverInfo("EqType");
136
137 // Check such a module exists for this equation.
138 ASSERTL0(GetEquationSystemFactory().ModuleExists(vEquation),
139 "EquationSystem '" + vEquation +
140 "' is not defined.\n"
141 "Ensure equation name is correct and module is compiled.\n");
142
143 // Set fine parallel-in-time solver.
144 ASSERTL0(m_session->DefinesCmdLineArgument("npt"),
145 "Number of parallel-in-time processes npt must be specified.");
146 m_session->SetTag("AdvectiveType", AdvectiveType);
147 m_session->SetTag("ParallelInTimeSolver", "TimeLevel0");
149 m_graph);
150
151 // Define argument for the coarse parallel-in-time solver.
152 int npx = m_session->DefinesCmdLineArgument("npx")
153 ? m_session->GetCmdLineArgument<int>("npx")
154 : 1;
155 int npy = m_session->DefinesCmdLineArgument("npy")
156 ? m_session->GetCmdLineArgument<int>("npy")
157 : 1;
158 int npz = m_session->DefinesCmdLineArgument("npz")
159 ? m_session->GetCmdLineArgument<int>("npz")
160 : 1;
161 int nsz = m_session->DefinesCmdLineArgument("nsz")
162 ? m_session->GetCmdLineArgument<int>("nsz")
163 : 1;
164 int npt = m_session->GetCmdLineArgument<int>("npt");
165
166 // Convert into string.
167 std::string npx_string = std::to_string(npx);
168 std::string npy_string = std::to_string(npy);
169 std::string npz_string = std::to_string(npz);
170 std::string nsz_string = std::to_string(nsz);
171 std::string npt_string = std::to_string(npt);
172 std::string driver_string = "Driver=" + m_session->GetSolverInfo("Driver");
173
174 // use-opt-file
175 bool useOptFile = m_session->DefinesCmdLineArgument("use-opt-file");
176 std::string optfilename = useOptFile ? m_session->GetFilenames()[0] : "";
177
178 char *argv[] = {const_cast<char *>("Solver"), // this is just a place holder
179 const_cast<char *>("--solverinfo"),
180 const_cast<char *>(driver_string.c_str()),
181 const_cast<char *>("--npx"),
182 const_cast<char *>(npx_string.c_str()),
183 const_cast<char *>("--npy"),
184 const_cast<char *>(npy_string.c_str()),
185 const_cast<char *>("--npz"),
186 const_cast<char *>(npz_string.c_str()),
187 const_cast<char *>("--nsz"),
188 const_cast<char *>(nsz_string.c_str()),
189 const_cast<char *>("--npt"),
190 const_cast<char *>(npt_string.c_str()),
191 const_cast<char *>("-f"),
192 const_cast<char *>("--use-opt-file"),
193 const_cast<char *>(optfilename.c_str()),
194 nullptr};
195
196 size_t argc = useOptFile ? 16 : 14;
197
198 // Get list of session file names.
199 std::vector<std::string> sessionFileNames;
200 for (auto &filename : m_session->GetFilenames())
201 {
202 // Remove optfile name, if necessary.
203 if (filename.substr(filename.find_last_of(".") + 1) != "opt")
204 {
205 sessionFileNames.push_back(filename);
206 }
207 }
208
209 // Set session for coarse solver.
210 for (size_t timeLevel = 1; timeLevel < m_nTimeLevel; timeLevel++)
211 {
213 argc, argv, sessionFileNames, m_session->GetComm(), timeLevel);
214
215 // Set graph for coarse solver.
218
219 // Set BndRegionOrdering (necessary for DG with periodic BC) FIXME
220 graph->SetBndRegionOrdering(m_graph->GetBndRegionOrdering());
221
222 // Set CompositeOrdering (necessary for DG with periodic BC) FIXME
223 graph->SetCompositeOrdering(m_graph->GetCompositeOrdering());
224
225 // Retrieve the equation system to solve.
226 ASSERTL0(session->DefinesSolverInfo("EqType"),
227 "EqType SolverInfo tag must be defined.");
228 auto vEquation = session->DefinesSolverInfo("SolverType")
229 ? session->GetSolverInfo("SolverType")
230 : session->GetSolverInfo("EqType");
231
232 // Check such a module exists for this equation.
233 ASSERTL0(
234 GetEquationSystemFactory().ModuleExists(vEquation),
235 "EquationSystem '" + vEquation +
236 "' is not defined.\n"
237 "Ensure equation name is correct and module is compiled.\n");
238
239 // Set coarse parallel-in-time solver.
240 session->SetTag("AdvectiveType", AdvectiveType);
241 session->SetTag("ParallelInTimeSolver",
242 "TimeLevel" + std::to_string(timeLevel));
244 vEquation, session, graph);
245 }
246}
#define ASSERTL0(condition, msg)
tBaseSharedPtr CreateInstance(tKey idKey, tParam... args)
Create an instance of the class referred to by idKey.
static SessionReaderSharedPtr CreateInstance(int argc, char *argv[])
Creates an instance of the SessionReader class.
SpatialDomains::MeshGraphSharedPtr m_graph
MeshGraph object.
Definition Driver.h:89
Array< OneD, EquationSystemSharedPtr > m_equ
Equation system to solve.
Definition Driver.h:92
static MeshGraphSharedPtr Read(const LibUtilities::SessionReaderSharedPtr pSession, LibUtilities::DomainRangeShPtr rng=LibUtilities::NullDomainRangeShPtr, bool fillGraph=true, SpatialDomains::MeshGraphSharedPtr partitionedGraph=nullptr)
static DomainRangeShPtr NullDomainRangeShPtr
Definition DomainRange.h:70
EquationSystemFactory & GetEquationSystemFactory()

References ASSERTL0, Nektar::LibUtilities::SessionReader::CreateInstance(), Nektar::LibUtilities::NekFactory< tKey, tBase, tParam >::CreateInstance(), Nektar::SolverUtils::GetEquationSystemFactory(), Nektar::SolverUtils::Driver::m_equ, Nektar::SolverUtils::Driver::m_graph, m_nTimeLevel, Nektar::SolverUtils::Driver::m_session, Nektar::LibUtilities::NullDomainRangeShPtr, and Nektar::SpatialDomains::MeshGraphIO::Read().

Referenced by v_InitObject().

◆ SolutionConvergenceMonitoring()

void Nektar::SolverUtils::DriverParallelInTime::SolutionConvergenceMonitoring ( const size_t  timeLevel,
const size_t  iter 
)
protected

Definition at line 484 of file DriverParallelInTime.cpp.

486{
487 PrintHeader((boost::format("ITERATION %1%") % iter).str(), '-');
488 UpdateErrorNorm(timeLevel, true);
489 PrintErrorNorm(timeLevel, true);
490}
void PrintErrorNorm(const size_t timeLevel, const bool normalized)
void PrintHeader(const std::string &title, const char c)
void UpdateErrorNorm(const size_t timeLevel, const bool normalized)

References PrintErrorNorm(), PrintHeader(), and UpdateErrorNorm().

Referenced by Nektar::SolverUtils::DriverParareal::v_Execute().

◆ SolutionConvergenceSummary()

void Nektar::SolverUtils::DriverParallelInTime::SolutionConvergenceSummary ( const size_t  timeLevel)
protected

Definition at line 495 of file DriverParallelInTime.cpp.

496{
497 UpdateErrorNorm(timeLevel, false);
498 PrintErrorNorm(timeLevel, false);
499}

References PrintErrorNorm(), and UpdateErrorNorm().

Referenced by Nektar::SolverUtils::DriverParareal::v_Execute(), and Nektar::SolverUtils::DriverPFASST::v_Execute().

◆ UpdateErrorNorm()

void Nektar::SolverUtils::DriverParallelInTime::UpdateErrorNorm ( const size_t  timeLevel,
const bool  normalized 
)
protected

Definition at line 504 of file DriverParallelInTime.cpp.

506{
507 for (size_t i = 0; i < m_nVar; ++i)
508 {
509 m_vL2Errors[i] =
510 m_EqSys[timeLevel]->L2Error(i, m_exactsoln[i], normalized);
511 m_vLinfErrors[i] = m_EqSys[timeLevel]->LinfError(i, m_exactsoln[i]);
512 }
513}

References m_EqSys, m_exactsoln, m_nVar, m_vL2Errors, and m_vLinfErrors.

Referenced by SolutionConvergenceMonitoring(), and SolutionConvergenceSummary().

◆ UpdateFieldCoeffs()

void Nektar::SolverUtils::DriverParallelInTime::UpdateFieldCoeffs ( const size_t  timeLevel,
const Array< OneD, const Array< OneD, NekDouble > > &  in = NullNekDoubleArrayOfArray 
)
protected

Definition at line 454 of file DriverParallelInTime.cpp.

456{
457 for (size_t i = 0; i < m_nVar; ++i)
458 {
460 {
461 m_EqSys[timeLevel]->CopyToPhysField(i, in[i]);
462 }
463 m_EqSys[timeLevel]->UpdateFields()[i]->FwdTrans(
464 m_EqSys[timeLevel]->UpdateFields()[i]->GetPhys(),
465 m_EqSys[timeLevel]->UpdateFields()[i]->UpdateCoeffs());
466 }
467}

References m_EqSys, m_nVar, and Nektar::NullNekDoubleArrayOfArray.

Referenced by Nektar::SolverUtils::DriverPFASST::WriteOutput(), and Nektar::SolverUtils::DriverParareal::WriteTimeChunkOuput().

◆ v_Execute()

void Nektar::SolverUtils::DriverParallelInTime::v_Execute ( std::ostream &  out = std::cout)
overrideprotectedvirtual

Virtual function for solve implementation.

Implements Nektar::SolverUtils::Driver.

Reimplemented in Nektar::SolverUtils::DriverParareal, and Nektar::SolverUtils::DriverPFASST.

Definition at line 120 of file DriverParallelInTime.cpp.

121{
122}

◆ v_InitObject()

void Nektar::SolverUtils::DriverParallelInTime::v_InitObject ( std::ostream &  out = std::cout)
overrideprotectedvirtual

Virtual function for initialisation implementation.

Reimplemented from Nektar::SolverUtils::Driver.

Reimplemented in Nektar::SolverUtils::DriverParareal, and Nektar::SolverUtils::DriverPFASST.

Definition at line 65 of file DriverParallelInTime.cpp.

66{
67 try
68 {
69 // Retrieve the type of evolution operator to use
71 m_session->GetSolverInfoAsEnum<EvolutionOperatorType>(
72 "EvolutionOperator");
73
74 m_nTimeLevel = 2; // Only two time levels currently implemented.
75
76 m_equ = Array<OneD, EquationSystemSharedPtr>(m_nTimeLevel);
77
78 // Set the AdvectiveType tag and create EquationSystem objects.
79 switch (m_EvolutionOperator)
80 {
81 case eNonlinear:
83 break;
84 case eDirect:
86 break;
87 case eAdjoint:
89 break;
90 case eSkewSymmetric:
91 SetParallelInTimeEquationSystem("SkewSymmetric");
92 break;
93 default:
94 ASSERTL0(false, "Unrecognised evolution operator.");
95 }
96
97 // Set pointers.
98 m_EqSys = Array<OneD, std::shared_ptr<UnsteadySystem>>(m_nTimeLevel);
99 for (size_t timeLevel = 0; timeLevel < m_nTimeLevel; timeLevel++)
100 {
101 m_EqSys[timeLevel] =
102 std::dynamic_pointer_cast<SolverUtils::UnsteadySystem>(
103 m_equ[timeLevel]);
104 }
105
106 // Set time communication parameters.
107 m_numChunks = m_comm->GetTimeComm()->GetSize();
108 m_chunkRank = m_comm->GetTimeComm()->GetRank();
109 }
110 catch (int e)
111 {
112 ASSERTL0(e == -1, "No such class class defined.");
113 out << "An error occurred during driver initialisation." << std::endl;
114 }
115}
enum EvolutionOperatorType m_EvolutionOperator
Evolution Operator.
Definition Driver.h:98
void SetParallelInTimeEquationSystem(std::string AdvectiveType)

References ASSERTL0, Nektar::SolverUtils::eAdjoint, Nektar::SolverUtils::eDirect, Nektar::SolverUtils::eNonlinear, Nektar::SolverUtils::eSkewSymmetric, m_chunkRank, Nektar::SolverUtils::Driver::m_comm, m_EqSys, Nektar::SolverUtils::Driver::m_equ, Nektar::SolverUtils::Driver::m_EvolutionOperator, m_nTimeLevel, m_numChunks, Nektar::SolverUtils::Driver::m_session, and SetParallelInTimeEquationSystem().

Referenced by Nektar::SolverUtils::DriverParareal::v_InitObject(), and Nektar::SolverUtils::DriverPFASST::v_InitObject().

◆ vL2ErrorMax()

NekDouble Nektar::SolverUtils::DriverParallelInTime::vL2ErrorMax ( void  )
protected

Definition at line 555 of file DriverParallelInTime.cpp.

556{
557 NekDouble L2Error = 0.0;
558 for (size_t i = 0; i < m_nVar; ++i)
559 {
560 L2Error = std::max(L2Error, m_vL2Errors[i]);
561 }
562 return L2Error;
563}

References m_nVar, and m_vL2Errors.

Referenced by Nektar::SolverUtils::DriverParareal::v_Execute(), and Nektar::SolverUtils::DriverPFASST::v_Execute().

Member Data Documentation

◆ m_chunkRank

size_t Nektar::SolverUtils::DriverParallelInTime::m_chunkRank
protected

◆ m_chunkTime

NekDouble Nektar::SolverUtils::DriverParallelInTime::m_chunkTime
protected

◆ m_EqSys

Array<OneD, std::shared_ptr<UnsteadySystem> > Nektar::SolverUtils::DriverParallelInTime::m_EqSys
protected

◆ m_exactsoln

Array<OneD, Array<OneD, NekDouble> > Nektar::SolverUtils::DriverParallelInTime::m_exactsoln
protected

◆ m_exactSolution

bool Nektar::SolverUtils::DriverParallelInTime::m_exactSolution
protected

Using exact solution to compute error norms.

Definition at line 145 of file DriverParallelInTime.h.

Referenced by GetParametersFromSession(), and Nektar::SolverUtils::DriverParareal::v_Execute().

◆ m_iterMaxPIT

size_t Nektar::SolverUtils::DriverParallelInTime::m_iterMaxPIT
protected

Maximum number of parallel-in-time iteration.

Definition at line 139 of file DriverParallelInTime.h.

Referenced by GetParametersFromSession(), Nektar::SolverUtils::DriverParareal::v_Execute(), and Nektar::SolverUtils::DriverPFASST::v_Execute().

◆ m_npts

Array<OneD, size_t> Nektar::SolverUtils::DriverParallelInTime::m_npts
protected

◆ m_nsteps

Array<OneD, size_t> Nektar::SolverUtils::DriverParallelInTime::m_nsteps
protected

◆ m_nTimeLevel

size_t Nektar::SolverUtils::DriverParallelInTime::m_nTimeLevel
protected

◆ m_numChunks

size_t Nektar::SolverUtils::DriverParallelInTime::m_numChunks
protected

◆ m_numWindowsPIT

size_t Nektar::SolverUtils::DriverParallelInTime::m_numWindowsPIT
protected

◆ m_nVar

size_t Nektar::SolverUtils::DriverParallelInTime::m_nVar
protected

◆ m_time

NekDouble Nektar::SolverUtils::DriverParallelInTime::m_time
protected

◆ m_time0

NekDouble Nektar::SolverUtils::DriverParallelInTime::m_time0
protected

◆ m_timestep

Array<OneD, NekDouble> Nektar::SolverUtils::DriverParallelInTime::m_timestep
protected

◆ m_tolerPIT

NekDouble Nektar::SolverUtils::DriverParallelInTime::m_tolerPIT
protected

◆ m_totalTime

NekDouble Nektar::SolverUtils::DriverParallelInTime::m_totalTime
protected

Total time integration interval.

Definition at line 123 of file DriverParallelInTime.h.

Referenced by Nektar::SolverUtils::DriverParareal::v_Execute(), and Nektar::SolverUtils::DriverPFASST::v_Execute().

◆ m_vL2Errors

Array<OneD, NekDouble> Nektar::SolverUtils::DriverParallelInTime::m_vL2Errors
protected

◆ m_vLinfErrors

Array<OneD, NekDouble> Nektar::SolverUtils::DriverParallelInTime::m_vLinfErrors
protected