Commit 49f2ca9a authored by Douglas Serson's avatar Douglas Serson

Change name from avgvalue to mean

parent e17e885f
......@@ -158,7 +158,6 @@ Specifically, FieldConvert has these additional functionalities
\item \inltt{L2Criterion}: Computes the Lambda 2 Criterion for a given output file;
\item \inltt{addcompositeid}: Adds the composite ID of an element as an additional field;
\item \inltt{addFld}: Sum two .fld files;
\item \inltt{avgvalue}: Evaluate average value of variables on the domain;
\item \inltt{combineAvg}: Combine two \nekpp binary output (.chk or .fld) field file containing averages of fields (and
possibly also Reynolds stresses) into single file;
\item \inltt{concatenate}: Concatenate a \nekpp binary output (.chk or .fld) field file into single file (deprecated);
......@@ -175,6 +174,7 @@ possibly also Reynolds stresses) into single file;
\item \inltt{isocontour}: Extract an isocontour of ``fieldid'' variable and at value ``fieldvalue''. Optionally ``fieldstr'' can be specified for a string definition or ``smooth'' for smoothing;
\item \inltt{jacobianenergy}: Shows high frequency energy of Jacobian;
\item \inltt{qualitymetric}: Evaluate a quality metric of the underlying mesh to show mesh quality;
\item \inltt{mean}: Evaluate the mean of variables on the domain;
\item \inltt{meanmode}: Extract mean mode (plane zero) of 3DH1D expansions;
\item \inltt{pointdatatofld}: Given discrete data at quadrature points
project them onto an expansion basis and output fld file;
......@@ -303,20 +303,6 @@ the result either in Tecplot, Paraview or VisIt.
%
%
%
\subsection{Evaluate average value of variables on the domain: \textit{avgvalue} module}
To evaluate average value of variables on the domain one can use the
\inltt{avgvalue} module of FieldConvert
%
\begin{lstlisting}[style=BashInputStyle]
FieldConvert -m avgvalue file1.xml file2.fld out.stdout
\end{lstlisting}
%
This module does not create an output file which is reinforced by the
out.stdout option. The integral and average value for each field variable are
then printed to the stdout.
%
%
%
\subsection{Combine two .fld files containing time averages: \textit{combineAvg} module}
To combine two .fld files obtained through the AverageFields or ReynoldsStresses filters,
use the \inltt{combineAvg} module of FieldConvert
......@@ -799,7 +785,20 @@ Two quality metrics are implemented that produce scalar fields $Q$:
%
%
%
\subsection{Evaluate the mean of variables on the domain: \textit{mean} module}
To evaluate the mean of variables on the domain one can use the
\inltt{mean} module of FieldConvert
%
\begin{lstlisting}[style=BashInputStyle]
FieldConvert -m mean file1.xml file2.fld out.stdout
\end{lstlisting}
%
This module does not create an output file which is reinforced by the
out.stdout option. The integral and mean for each field variable are
then printed to the stdout.
%
%
%
\subsection{Extract mean mode of 3DH1D expansion: \textit{meanmode} module}
To obtain a 2D expansion containing the mean mode (plane zero in Fourier space) of a
......
......@@ -18,7 +18,6 @@ SET(FieldUtilsHeaders
OutputModules/OutputXml.h
ProcessModules/ProcessAddCompositeID.h
ProcessModules/ProcessAddFld.h
ProcessModules/ProcessAvgValue.h
ProcessModules/ProcessBoundaryExtract.h
ProcessModules/ProcessCombineAvg.h
ProcessModules/ProcessConcatenateFld.h
......@@ -39,6 +38,7 @@ SET(FieldUtilsHeaders
ProcessModules/ProcessL2Criterion.h
ProcessModules/ProcessMapping.h
ProcessModules/ProcessNumModes.h
ProcessModules/ProcessMean.h
ProcessModules/ProcessMeanMode.h
ProcessModules/ProcessPointDataToFld.h
ProcessModules/ProcessPrintFldNorms.h
......@@ -73,7 +73,6 @@ SET(FieldUtilsSources
OutputModules/OutputXml.cpp
ProcessModules/ProcessAddCompositeID.cpp
ProcessModules/ProcessAddFld.cpp
ProcessModules/ProcessAvgValue.cpp
ProcessModules/ProcessBoundaryExtract.cpp
ProcessModules/ProcessCombineAvg.cpp
ProcessModules/ProcessConcatenateFld.cpp
......@@ -94,6 +93,7 @@ SET(FieldUtilsSources
ProcessModules/ProcessL2Criterion.cpp
ProcessModules/ProcessMapping.cpp
ProcessModules/ProcessNumModes.cpp
ProcessModules/ProcessMean.cpp
ProcessModules/ProcessMeanMode.cpp
ProcessModules/ProcessPointDataToFld.cpp
ProcessModules/ProcessPrintFldNorms.cpp
......
////////////////////////////////////////////////////////////////////////////////
//
// File: ProcessAvgValue.cpp
// File: ProcessMean.cpp
//
// For more information, please see: http://www.nektar.info/
//
......@@ -29,7 +29,7 @@
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
// DEALINGS IN THE SOFTWARE.
//
// Description: Compute the average value of each field.
// Description: Compute the mean of each field.
//
////////////////////////////////////////////////////////////////////////////////
......@@ -37,7 +37,7 @@
#include <string>
using namespace std;
#include "ProcessAvgValue.h"
#include "ProcessMean.h"
#include <LibUtilities/BasicUtils/SharedArray.hpp>
......@@ -46,20 +46,20 @@ namespace Nektar
namespace FieldUtils
{
ModuleKey ProcessAvgValue::className =
ModuleKey ProcessMean::className =
GetModuleFactory().RegisterCreatorFunction(
ModuleKey(eProcessModule, "avgvalue"), ProcessAvgValue::create,
"compute the average value of each field.");
ModuleKey(eProcessModule, "mean"), ProcessMean::create,
"compute the mean of each field over the domain.");
ProcessAvgValue::ProcessAvgValue(FieldSharedPtr f) : ProcessModule(f)
ProcessMean::ProcessMean(FieldSharedPtr f) : ProcessModule(f)
{
}
ProcessAvgValue::~ProcessAvgValue()
ProcessMean::~ProcessMean()
{
}
void ProcessAvgValue::Process(po::variables_map &vm)
void ProcessMean::Process(po::variables_map &vm)
{
int nfields = m_f->m_variables.size();
int spacedim = m_f->m_graph->GetMeshDimension() + m_f->m_numHomogeneousDir;
......@@ -73,7 +73,7 @@ void ProcessAvgValue::Process(po::variables_map &vm)
string name[3] = {"length", "area", "volume"};
cout << "Domain " << name[spacedim - 1] << " : " << scale << endl;
// Calculate integral and average of each field
// Calculate integral and mean of each field
for (int i = 0; i < nfields; ++i)
{
NekDouble integral = m_f->m_exp[0]->Integral(m_f->m_exp[i]->GetPhys());
......@@ -81,7 +81,7 @@ void ProcessAvgValue::Process(po::variables_map &vm)
{
cout << "Integral (variable " << m_f->m_variables[i]
<< ") : " << integral << endl;
cout << "Average value (variable " << m_f->m_variables[i]
cout << "Mean (variable " << m_f->m_variables[i]
<< ") : " << integral / scale << endl;
}
}
......
////////////////////////////////////////////////////////////////////////////////
//
// File: ProcessAvgValue.h
// File: ProcessMean.h
//
// For more information, please see: http://www.nektar.info/
//
......@@ -29,12 +29,12 @@
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
// DEALINGS IN THE SOFTWARE.
//
// Description: Compute the average value of each field.
// Description: Compute the mean of each field.
//
////////////////////////////////////////////////////////////////////////////////
#ifndef FIELDUTILS_PROCESSAVGVALUE
#define FIELDUTILS_PROCESSAVGVALUE
#ifndef FIELDUTILS_PROCESSMEAN
#define FIELDUTILS_PROCESSMEAN
#include "../Module.h"
......@@ -44,33 +44,33 @@ namespace FieldUtils
{
/**
* @brief This processing module computes the average value of each field.
* @brief This processing module computes the mean of each field.
*
*/
class ProcessAvgValue : public ProcessModule
class ProcessMean : public ProcessModule
{
public:
/// Creates an instance of this class
static std::shared_ptr<Module> create(FieldSharedPtr f)
{
return MemoryManager<ProcessAvgValue>::AllocateSharedPtr(f);
return MemoryManager<ProcessMean>::AllocateSharedPtr(f);
}
static ModuleKey className;
ProcessAvgValue(FieldSharedPtr f);
virtual ~ProcessAvgValue();
ProcessMean(FieldSharedPtr f);
virtual ~ProcessMean();
/// Write mesh to output file.
virtual void Process(po::variables_map &vm);
virtual std::string GetModuleName()
{
return "ProcessAvgValue";
return "ProcessMean";
}
virtual std::string GetModuleDescription()
{
return "Evaluating average value";
return "Evaluating mean";
}
virtual ModulePriority GetModulePriority()
......
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