Commit 7e1d2e36 authored by David Moxey's avatar David Moxey
Browse files

Add a little more doxygen

parent dfd6d635
......@@ -43,6 +43,12 @@ namespace Nektar
std::string FilterEnergy1D::className = GetFilterFactory().
RegisterCreatorFunction("Energy1D", FilterEnergy1D::create);
/**
* @brief Set up filter with output file and frequency parameters.
*
* @param pSession Current session.
* @param pParams Map of parameters defined in XML file.
*/
FilterEnergy1D::FilterEnergy1D(
const LibUtilities::SessionReaderSharedPtr &pSession,
const std::map<std::string, std::string> &pParams) :
......@@ -79,11 +85,17 @@ namespace Nektar
m_out.open(outName);
}
/**
* @brief Destructor.
*/
FilterEnergy1D::~FilterEnergy1D()
{
}
/**
* @brief Initialize filter.
*/
void FilterEnergy1D::v_Initialise(
const Array<OneD, const MultiRegions::ExpListSharedPtr> &pFields,
const NekDouble &time)
......@@ -92,6 +104,10 @@ namespace Nektar
"The Energy 1D filter is only valid in 1D.");
}
/**
* @brief Update filter output with the current timestep's orthogonal
* coefficients.
*/
void FilterEnergy1D::v_Update(
const Array<OneD, const MultiRegions::ExpListSharedPtr> &pFields,
const NekDouble &time)
......
......@@ -42,6 +42,14 @@ namespace Nektar
{
namespace SolverUtils
{
/**
* @brief Filter for one-dimensional energy spectrum.
*
* This filter transforms the coefficients of each element into an
* orthogonal basis and outputs these coefficients at each timestep. It
* can be used to, for example, detect high-order oscillations in the
* solution field.
*/
class FilterEnergy1D : public Filter
{
public:
......
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