Nektar::SolverUtils::FilterEnergy Class Reference

#include <FilterEnergy.h>

Inheritance diagram for Nektar::SolverUtils::FilterEnergy:

Public Member Functions
SOLVER_UTILS_EXPORT	FilterEnergy (const LibUtilities::SessionReaderSharedPtr &pSession, const std::shared_ptr< EquationSystem > &pEquation, const ParamMap &pParams)
SOLVER_UTILS_EXPORT	~FilterEnergy () override
Public Member Functions inherited from Nektar::SolverUtils::Filter
SOLVER_UTILS_EXPORT	Filter (const LibUtilities::SessionReaderSharedPtr &pSession, const std::shared_ptr< EquationSystem > &pEquation)
virtual SOLVER_UTILS_EXPORT	~Filter ()
SOLVER_UTILS_EXPORT void	Initialise (const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time)
SOLVER_UTILS_EXPORT void	Update (const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time)
SOLVER_UTILS_EXPORT void	Finalise (const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time)
SOLVER_UTILS_EXPORT bool	IsTimeDependent ()
SOLVER_UTILS_EXPORT std::string	SetupOutput (const std::string ext, const ParamMap &pParams)
SOLVER_UTILS_EXPORT std::string	SetupOutput (const std::string ext, const std::string inname)
SOLVER_UTILS_EXPORT void	SetUpdateOnInitialise (bool flag)

Static Public Member Functions
static SolverUtils::FilterSharedPtr	create (const LibUtilities::SessionReaderSharedPtr &pSession, const std::shared_ptr< SolverUtils::EquationSystem > &pEquation, const ParamMap &pParams)
	Creates an instance of this class. More...

Static Public Attributes
static std::string	className
	Name of the class. More...

Protected Member Functions
SOLVER_UTILS_EXPORT void	v_Initialise (const Array< OneD, const MultiRegions::ExpListSharedPtr > &pField, const NekDouble &time) override
SOLVER_UTILS_EXPORT void	v_Update (const Array< OneD, const MultiRegions::ExpListSharedPtr > &pField, const NekDouble &time) override
SOLVER_UTILS_EXPORT void	v_Finalise (const Array< OneD, const MultiRegions::ExpListSharedPtr > &pField, const NekDouble &time) override
SOLVER_UTILS_EXPORT bool	v_IsTimeDependent () override
Protected Member Functions inherited from Nektar::SolverUtils::Filter
virtual void	v_Initialise (const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time)=0
virtual void	v_Update (const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time)=0
virtual void	v_Finalise (const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time)=0
virtual bool	v_IsTimeDependent ()=0
virtual SOLVER_UTILS_EXPORT std::string	v_SetupOutput (const std::string ext, const ParamMap &pParams)
virtual SOLVER_UTILS_EXPORT std::string	v_SetupOutput (const std::string ext, const std::string inname)

Private Attributes
unsigned int	m_index
unsigned int	m_outputFrequency
std::ofstream	m_outFile
bool	m_homogeneous
NekDouble	m_homogeneousLength
NekDouble	m_area
LibUtilities::CommSharedPtr	m_comm
Array< OneD, unsigned int >	m_planes

Additional Inherited Members
Public Types inherited from Nektar::SolverUtils::Filter
typedef std::map< std::string, std::string >	ParamMap
Protected Attributes inherited from Nektar::SolverUtils::Filter
LibUtilities::SessionReaderSharedPtr	m_session
const std::weak_ptr< EquationSystem >	m_equ
bool	m_updateOnInitialise = true

Detailed Description

Definition at line 42 of file FilterEnergy.h.

Constructor & Destructor Documentation

FilterEnergy()

Nektar::SolverUtils::FilterEnergy::FilterEnergy	(	const LibUtilities::SessionReaderSharedPtr &	pSession,
		const std::shared_ptr< EquationSystem > &	pEquation,
		const ParamMap &	pParams
	)

Definition at line 48 of file FilterEnergy.cpp.

    : Filter(pSession, pEquation), m_index(-1), m_homogeneous(false), m_planes()
{
    std::string outName;
    std::string ext = ".eny";
    outName         = Filter::SetupOutput(ext, pParams);
 
    m_comm = pSession->GetComm();
    if (m_comm->GetRank() == 0)
    {
        m_outFile.open(outName.c_str());
        ASSERTL0(m_outFile.good(), "Unable to open: '" + outName + "'");
        m_outFile.setf(ios::scientific, ios::floatfield);
        m_outFile << "# Time                Kinetic energy        "
                  << "Enstrophy" << endl
                  << "# ---------------------------------------------"
                  << "--------------" << endl;
    }
    pSession->LoadParameter("LZ", m_homogeneousLength, 0.0);
 
    // OutputFrequency
    auto it = pParams.find("OutputFrequency");
    ASSERTL0(it != pParams.end(), "Missing parameter 'OutputFrequency'.");
    LibUtilities::Equation equ(m_session->GetInterpreter(), it->second);
    m_outputFrequency = round(equ.Evaluate());
}

References ASSERTL0, Nektar::LibUtilities::Equation::Evaluate(), m_comm, m_homogeneousLength, m_outFile, m_outputFrequency, Nektar::SolverUtils::Filter::m_session, and Nektar::SolverUtils::Filter::SetupOutput().

~FilterEnergy()

Nektar::SolverUtils::FilterEnergy::~FilterEnergy ( )

override

Definition at line 77 of file FilterEnergy.cpp.

{
}

Member Function Documentation

create()

static SolverUtils::FilterSharedPtr Nektar::SolverUtils::FilterEnergy::create ( const LibUtilities::SessionReaderSharedPtr &  pSession, const std::shared_ptr< SolverUtils::EquationSystem > &  pEquation, const ParamMap &  pParams  )

inlinestatic

Creates an instance of this class.

Definition at line 46 of file FilterEnergy.h.

    {
        SolverUtils::FilterSharedPtr p =
            MemoryManager<FilterEnergy>::AllocateSharedPtr(pSession, pEquation,
                                                           pParams);
        return p;
    }

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

v_Finalise()

void Nektar::SolverUtils::FilterEnergy::v_Finalise ( const Array< OneD, const MultiRegions::ExpListSharedPtr > &  pField, const NekDouble &  time  )

overrideprotectedvirtual

Implements Nektar::SolverUtils::Filter.

Definition at line 251 of file FilterEnergy.cpp.

{
    m_outFile.close();
}

References m_outFile.

v_Initialise()

void Nektar::SolverUtils::FilterEnergy::v_Initialise ( const Array< OneD, const MultiRegions::ExpListSharedPtr > &  pField, const NekDouble &  time  )

overrideprotectedvirtual

Implements Nektar::SolverUtils::Filter.

Definition at line 81 of file FilterEnergy.cpp.

{
    m_index = -1;
    MultiRegions::ExpListSharedPtr areaField;
 
    ASSERTL0(pFields[0]->GetExpType() != MultiRegions::e1D,
             "1D expansion not supported for energy filter");
 
    ASSERTL0(pFields[0]->GetExpType() != MultiRegions::e2D,
             "2D expansion not supported for energy filter");
 
    ASSERTL0(pFields[0]->GetExpType() != MultiRegions::e3DH2D,
             "Homogeneous 2D expansion not supported for energy filter");
 
    if (pFields[0]->GetExpType() == MultiRegions::e3DH1D)
    {
        m_homogeneous = true;
    }
 
    // Calculate area/volume of domain.
    if (m_homogeneous)
    {
        m_planes  = pFields[0]->GetZIDs();
        areaField = pFields[0]->GetPlane(0);
    }
    else
    {
        areaField = pFields[0];
    }
 
    Array<OneD, NekDouble> inarray(areaField->GetNpoints(), 1.0);
    m_area = areaField->Integral(inarray);
 
    if (m_homogeneous)
    {
        m_area *= m_homogeneousLength;
    }
    if (m_updateOnInitialise)
    {
        v_Update(pFields, time);
    }
}

References ASSERTL0, Nektar::MultiRegions::e1D, Nektar::MultiRegions::e2D, Nektar::MultiRegions::e3DH1D, Nektar::MultiRegions::e3DH2D, m_area, m_homogeneous, m_homogeneousLength, m_index, m_planes, Nektar::SolverUtils::Filter::m_updateOnInitialise, and v_Update().

v_IsTimeDependent()

bool Nektar::SolverUtils::FilterEnergy::v_IsTimeDependent ( )

overrideprotectedvirtual

Implements Nektar::SolverUtils::Filter.

Definition at line 259 of file FilterEnergy.cpp.

{
    return true;
}

v_Update()

void Nektar::SolverUtils::FilterEnergy::v_Update ( const Array< OneD, const MultiRegions::ExpListSharedPtr > &  pField, const NekDouble &  time  )

overrideprotectedvirtual

Implements Nektar::SolverUtils::Filter.

Definition at line 126 of file FilterEnergy.cpp.

{
    int i, nPoints = pFields[0]->GetNpoints();
 
    m_index++;
 
    if (m_index % m_outputFrequency > 0)
    {
        return;
    }
 
    // Lock equation system pointer
    auto equ = m_equ.lock();
    ASSERTL0(equ, "Weak pointer expired");
 
    auto fluidEqu = std::dynamic_pointer_cast<FluidInterface>(equ);
    ASSERTL0(fluidEqu, "Energy filter is incompatible with this solver.");
 
    // Store physical values in an array
    Array<OneD, Array<OneD, NekDouble>> physfields(pFields.size());
    for (i = 0; i < pFields.size(); ++i)
    {
        physfields[i] = pFields[i]->GetPhys();
    }
 
    // Calculate kinetic energy.
    NekDouble Ek = 0.0;
    Array<OneD, NekDouble> tmp(nPoints, 0.0);
    Array<OneD, NekDouble> density;
    Array<OneD, Array<OneD, NekDouble>> u(3);
    for (i = 0; i < 3; ++i)
    {
        u[i] = Array<OneD, NekDouble>(nPoints);
    }
    fluidEqu->GetVelocity(physfields, u);
 
    for (i = 0; i < 3; ++i)
    {
        if (m_homogeneous && pFields[i]->GetWaveSpace())
        {
            pFields[i]->HomogeneousBwdTrans(nPoints, u[i], u[i]);
        }
 
        Vmath::Vvtvp(nPoints, u[i], 1, u[i], 1, tmp, 1, tmp, 1);
    }
 
    if (!fluidEqu->HasConstantDensity())
    {
        density = Array<OneD, NekDouble>(nPoints);
        fluidEqu->GetDensity(physfields, density);
        Vmath::Vmul(nPoints, density, 1, tmp, 1, tmp, 1);
    }
 
    if (m_homogeneous)
    {
        Array<OneD, NekDouble> tmp2(nPoints, 0.0);
        pFields[0]->HomogeneousFwdTrans(nPoints, tmp, tmp2);
        Ek = pFields[0]->GetPlane(0)->Integral(tmp2) * m_homogeneousLength;
    }
    else
    {
        Ek = pFields[0]->Integral(tmp);
    }
 
    Ek /= 2.0 * m_area;
 
    if (m_comm->GetRank() == 0)
    {
        m_outFile << setw(17) << setprecision(8) << time << setw(22)
                  << setprecision(11) << Ek;
    }
 
    bool waveSpace[3] = {pFields[0]->GetWaveSpace(), pFields[1]->GetWaveSpace(),
                         pFields[2]->GetWaveSpace()};
 
    if (m_homogeneous)
    {
        for (i = 0; i < 3; ++i)
        {
            pFields[i]->SetWaveSpace(false);
        }
    }
 
    // First calculate vorticity field.
    Array<OneD, NekDouble> tmp2(nPoints), tmp3(nPoints);
    Vmath::Zero(nPoints, tmp, 1);
    for (i = 0; i < 3; ++i)
    {
        int f1 = (i + 2) % 3, c2 = f1;
        int c1 = (i + 1) % 3, f2 = c1;
        pFields[f1]->PhysDeriv(c1, u[f1], tmp2);
        pFields[f2]->PhysDeriv(c2, u[f2], tmp3);
        Vmath::Vsub(nPoints, tmp2, 1, tmp3, 1, tmp2, 1);
        Vmath::Vvtvp(nPoints, tmp2, 1, tmp2, 1, tmp, 1, tmp, 1);
    }
 
    if (!fluidEqu->HasConstantDensity())
    {
        Vmath::Vmul(nPoints, density, 1, tmp, 1, tmp, 1);
    }
 
    if (m_homogeneous)
    {
        for (i = 0; i < 3; ++i)
        {
            pFields[i]->SetWaveSpace(waveSpace[i]);
        }
        pFields[0]->HomogeneousFwdTrans(nPoints, tmp, tmp);
        Ek = pFields[0]->GetPlane(0)->Integral(tmp) * m_homogeneousLength;
    }
    else
    {
        Ek = pFields[0]->Integral(tmp);
    }
 
    Ek /= 2.0 * m_area;
 
    if (m_comm->GetRank() == 0)
    {
        m_outFile << setw(22) << setprecision(11) << Ek << endl;
    }
}

References ASSERTL0, m_area, m_comm, Nektar::SolverUtils::Filter::m_equ, m_homogeneous, m_homogeneousLength, m_index, m_outFile, m_outputFrequency, Vmath::Vmul(), Vmath::Vsub(), Vmath::Vvtvp(), and Vmath::Zero().

Referenced by v_Initialise().

Member Data Documentation

className

std::string Nektar::SolverUtils::FilterEnergy::className

static

Initial value:

=
    SolverUtils::GetFilterFactory().RegisterCreatorFunction(
        "Energy", FilterEnergy::create)

Name of the class.

Definition at line 58 of file FilterEnergy.h.

m_area

NekDouble Nektar::SolverUtils::FilterEnergy::m_area

private

Definition at line 84 of file FilterEnergy.h.

Referenced by v_Initialise(), and v_Update().

m_comm

LibUtilities::CommSharedPtr Nektar::SolverUtils::FilterEnergy::m_comm

private

Definition at line 85 of file FilterEnergy.h.

Referenced by FilterEnergy(), and v_Update().

m_homogeneous

bool Nektar::SolverUtils::FilterEnergy::m_homogeneous

private

Definition at line 82 of file FilterEnergy.h.

Referenced by v_Initialise(), and v_Update().

m_homogeneousLength

NekDouble Nektar::SolverUtils::FilterEnergy::m_homogeneousLength

private

Definition at line 83 of file FilterEnergy.h.

Referenced by FilterEnergy(), v_Initialise(), and v_Update().

m_index

unsigned int Nektar::SolverUtils::FilterEnergy::m_index

private

Definition at line 79 of file FilterEnergy.h.

Referenced by v_Initialise(), and v_Update().

m_outFile

std::ofstream Nektar::SolverUtils::FilterEnergy::m_outFile

private

Definition at line 81 of file FilterEnergy.h.

Referenced by FilterEnergy(), v_Finalise(), and v_Update().

m_outputFrequency

unsigned int Nektar::SolverUtils::FilterEnergy::m_outputFrequency

private

Definition at line 80 of file FilterEnergy.h.

Referenced by FilterEnergy(), and v_Update().

m_planes

Array<OneD, unsigned int> Nektar::SolverUtils::FilterEnergy::m_planes

private

Definition at line 86 of file FilterEnergy.h.

Referenced by v_Initialise().