Commit 41e8c92e authored by Andrea Cassinelli's avatar Andrea Cassinelli

Added user guide documentation

parent 12bf460e
......@@ -23,6 +23,13 @@ names are shared between filter types for consistency. Numerical filter
parameters may be expressions and so may include session parameters defined in
the \inltt{PARAMETERS} section.
Some filters may perform a large number of operations, potentially taking up
a significant percentage of the total simulation time. For this purpose, the parameter
\inltt{IO\_FiltersInfoSteps} is used to set the number of steps between successive total
filter CPU time stats are printed. By default it is set to 10 times \inltt{IO\_InfoSteps}. If the
solver is run with the verbose \inltt{-v} flag, further information is printed, detailing the
CPU time of each individual filter and percentage of time integration.
In the following we document the filters implemented. Note that some filters are
solver-specific and will therefore only work for a given subset of the available
......@@ -263,7 +263,6 @@ namespace Nektar
NekDouble cpuPrevious = 0.0;
NekDouble elapsed = 0.0;
NekDouble totFilterTime = 0.0;
// Array<OneD, NekDouble> fields(nvariables);
while (step < m_steps ||
m_time < m_fintime - NekConstants::kNekZeroTol)
......@@ -387,6 +386,7 @@ namespace Nektar
elapsed = timer.TimePerTest(1);
totFilterTime += elapsed;
// Write out individual filter status information
if(m_session->GetComm()->GetRank() == 0 &&
!((step+1) % m_filtersInfosteps) && !m_filters.empty() &&
......@@ -403,8 +403,8 @@ namespace Nektar
<< setw(10) << left << s2.str() << endl;
// Write out filters status information
// Write out overall filter status information
if (m_session->GetComm()->GetRank() == 0 &&
!((step+1) % m_filtersInfosteps) && !m_filters.empty())
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment