#include <FilterAeroForcesSPM.h>

Inheritance diagram for Nektar::FilterAeroForcesSPM:

Public Member Functions
void	CalculateForces (const Array< OneD, Array< OneD, NekDouble > > &pIntVel, const Array< OneD, Array< OneD, NekDouble > > &pUpPrev, const MultiRegions::ExpListSharedPtr &pPhi, NekDouble time, NekDouble dt)
	Determine the total force on the body defined by \(\Phi\) (note that if the shape function represents more than one body, this function calculates the value of the final force after adding up the values for each body). This value must be scaled with the density to get the real force vector. More...

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 std::map< std::string, std::string > &pParams)
	Creates an instance of this class. More...

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

Protected Member Functions
	FilterAeroForcesSPM (const LibUtilities::SessionReaderSharedPtr &pSession, const std::shared_ptr< SolverUtils::EquationSystem > &pEquation, const std::map< std::string, std::string > &pParams)

	~FilterAeroForcesSPM () override=default

void	v_Initialise (const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time) override

void	v_Update (const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time) override

void	v_Finalise (const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time) override

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)

Protected Attributes
unsigned int	m_index

unsigned int	m_outputFrequency

std::string	m_outputFile

std::ofstream	m_outputStream

NekDouble	m_startTime

std::vector< std::string >	m_dirNames
	STL vector containing the names of the different directions. More...

NekDouble	m_spaceDim
	Dimension of the fluid domain. More...

Array< OneD, NekDouble >	m_Forces
	Array storing the last value of the aerodynamic forces. More...

Protected Attributes inherited from Nektar::SolverUtils::Filter
LibUtilities::SessionReaderSharedPtr	m_session

const std::weak_ptr< EquationSystem >	m_equ

bool	m_updateOnInitialise = true

Friends
class	MemoryManager< FilterAeroForcesSPM >

Additional Inherited Members
Public Types inherited from Nektar::SolverUtils::Filter
typedef std::map< std::string, std::string >	ParamMap

Detailed Description

Definition at line 44 of file FilterAeroForcesSPM.h.

Constructor & Destructor Documentation

◆ FilterAeroForcesSPM()

Nektar::FilterAeroForcesSPM::FilterAeroForcesSPM	(	const LibUtilities::SessionReaderSharedPtr &	pSession,
		const std::shared_ptr< SolverUtils::EquationSystem > &	pEquation,
		const std::map< std::string, std::string > &	pParams
	)

protected

Definition at line 48 of file FilterAeroForcesSPM.cpp.

    : Filter(pSession, pEquation)
{
    // OutputFile
    std::string ext = ".fce";
    m_outputFile    = Filter::SetupOutput(ext, pParams);
 
    // OutputFrequency
    auto it = pParams.find("OutputFrequency");
    if (it == pParams.end())
    {
        m_outputFrequency = 1;
    }
    else
    {
        LibUtilities::Equation equ(m_session->GetInterpreter(), it->second);
        m_outputFrequency = round(equ.Evaluate());
    }
 
    // Time after which we need to calculate the forces
    it = pParams.find("StartTime");
    if (it == pParams.end())
    {
        m_startTime = 0;
    }
    else
    {
        LibUtilities::Equation equ(m_session->GetInterpreter(), it->second);
        m_startTime = equ.Evaluate();
    }
}

References Nektar::LibUtilities::Equation::Evaluate(), m_outputFile, m_outputFrequency, Nektar::SolverUtils::Filter::m_session, m_startTime, and Nektar::SolverUtils::Filter::SetupOutput().

◆ ~FilterAeroForcesSPM()

Nektar::FilterAeroForcesSPM::~FilterAeroForcesSPM ( )

overrideprotecteddefault

Member Function Documentation

◆ CalculateForces()

void Nektar::FilterAeroForcesSPM::CalculateForces	(	const Array< OneD, Array< OneD, NekDouble > > &	pIntVel,
		const Array< OneD, Array< OneD, NekDouble > > &	pUpPrev,
		const MultiRegions::ExpListSharedPtr &	pPhi,
		NekDouble	time,
		NekDouble	dt
	)

Determine the total force on the body defined by \(\Phi\) (note that if the shape function represents more than one body, this function calculates the value of the final force after adding up the values for each body). This value must be scaled with the density to get the real force vector.

Parameters

pIntVel
pUpPrev
pPhi
time
dt

Definition at line 205 of file FilterAeroForcesSPM.cpp.

{
    // Only output every m_outputFrequency.
    if ((m_index % m_outputFrequency) || (time < m_startTime))
    {
        return;
    }
 
    int nq = pIntVel[0].size();
    Array<OneD, NekDouble> tmp(nq);
 
    // Aerodynamic forces are computed according eq. 18a in Luo et al. (2009).
    // Smoothed profile method for particulate flows: Error analysis and
    // simulations. Journal of Computational Physics, 228(5)
    for (int i = 0; i < m_spaceDim; ++i)
    {
        // "Scalar" field to be integrated
        Vmath::Vsub(nq, pIntVel[i], 1, pUpPrev[i], 1, tmp, 1);
        Vmath::Vmul(nq, pPhi->GetPhys(), 1, tmp, 1, tmp, 1);
 
        // Integration of force throughout the domain
        m_Forces[i] = pPhi->Integral(tmp) / dt;
    }
}

References m_Forces, m_index, m_outputFrequency, m_spaceDim, m_startTime, Vmath::Vmul(), and Vmath::Vsub().

◆ create()

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

inlinestatic

Creates an instance of this class.

Definition at line 50 of file FilterAeroForcesSPM.h.

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

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

◆ v_Finalise()

void Nektar::FilterAeroForcesSPM::v_Finalise	(	const Array< OneD, const MultiRegions::ExpListSharedPtr > &	pFields,
		const NekDouble &	time
	)

overrideprotectedvirtual

Implements Nektar::SolverUtils::Filter.

Definition at line 174 of file FilterAeroForcesSPM.cpp.

{
    if (pFields[0]->GetComm()->GetRank() == 0)
    {
        m_outputStream.close();
    }
}

References m_outputStream.

◆ v_Initialise()

void Nektar::FilterAeroForcesSPM::v_Initialise	(	const Array< OneD, const MultiRegions::ExpListSharedPtr > &	pFields,
		const NekDouble &	time
	)

overrideprotectedvirtual

Implements Nektar::SolverUtils::Filter.

Definition at line 86 of file FilterAeroForcesSPM.cpp.

{
    // Save space dimension
    m_spaceDim = pFields[0]->GetGraph()->GetMeshDimension();
 
    // Fill in the directions vector
    m_dirNames.push_back("X");
    if (m_spaceDim > 1)
    {
        m_dirNames.push_back("Y");
    }
    if (m_spaceDim > 2)
    {
        m_dirNames.push_back("Z");
    }
 
    // Allocate the aero-forces vector
    m_Forces = Array<OneD, NekDouble>(m_spaceDim);
 
    // Write header
    LibUtilities::CommSharedPtr vComm = pFields[0]->GetComm();
    if (vComm->GetRank() == 0)
    {
        // Open output stream
        bool adaptive;
        m_session->MatchSolverInfo("Driver", "Adaptive", adaptive, false);
        if (adaptive)
        {
            m_outputStream.open(m_outputFile.c_str(), std::ofstream::app);
        }
        else
        {
            m_outputStream.open(m_outputFile.c_str());
        }
        m_outputStream << "# Forces acting on bodies\n";
        m_outputStream << "#";
        m_outputStream.width(7);
        m_outputStream << "Time";
        for (int i = 0; i < m_spaceDim; ++i)
        {
            m_outputStream.width(14);
            m_outputStream << "F_" << m_dirNames[i];
        }
 
        m_outputStream << std::endl;
    }
 
    m_index = 0;
}

References m_dirNames, m_Forces, m_index, m_outputFile, m_outputStream, Nektar::SolverUtils::Filter::m_session, and m_spaceDim.

◆ v_IsTimeDependent()

bool Nektar::FilterAeroForcesSPM::v_IsTimeDependent ( )

overrideprotectedvirtual

Implements Nektar::SolverUtils::Filter.

Definition at line 187 of file FilterAeroForcesSPM.cpp.

{
    return true;
}

◆ v_Update()

void Nektar::FilterAeroForcesSPM::v_Update	(	const Array< OneD, const MultiRegions::ExpListSharedPtr > &	pFields,
		const NekDouble &	time
	)

overrideprotectedvirtual

Implements Nektar::SolverUtils::Filter.

Definition at line 141 of file FilterAeroForcesSPM.cpp.

{
    // Only output every m_outputFrequency.
    if ((m_index++) % m_outputFrequency || (time < m_startTime))
    {
        return;
    }
 
    // Communicators to exchange results
    LibUtilities::CommSharedPtr vComm = pFields[0]->GetComm();
 
    // Write Results
    if (vComm->GetRank() == 0)
    {
        // Write time
        m_outputStream.width(8);
        m_outputStream << std::setprecision(6) << time;
        // Write forces
        for (int i = 0; i < m_spaceDim; ++i)
        {
            m_outputStream.width(15);
            m_outputStream << std::setprecision(8) << m_Forces[i];
        }
        m_outputStream.width(10);
        m_outputStream << std::endl;
    }
}

References m_Forces, m_index, m_outputFrequency, m_outputStream, m_spaceDim, and m_startTime.

Friends And Related Function Documentation

◆ MemoryManager< FilterAeroForcesSPM >

friend class MemoryManager< FilterAeroForcesSPM >

friend

Definition at line 108 of file FilterAeroForcesSPM.h.

Member Data Documentation

◆ className

std::string Nektar::FilterAeroForcesSPM::className

static

Initial value:

=
    SolverUtils::GetFilterFactory().RegisterCreatorFunction(
        "AeroForcesSPM", FilterAeroForcesSPM::create)

Name of the class.

Definition at line 62 of file FilterAeroForcesSPM.h.

◆ m_dirNames

std::vector<std::string> Nektar::FilterAeroForcesSPM::m_dirNames

protected

STL vector containing the names of the different directions.

Definition at line 78 of file FilterAeroForcesSPM.h.

Referenced by v_Initialise().

◆ m_Forces

Array<OneD, NekDouble> Nektar::FilterAeroForcesSPM::m_Forces

protected

Array storing the last value of the aerodynamic forces.

Definition at line 82 of file FilterAeroForcesSPM.h.

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

◆ m_index

unsigned int Nektar::FilterAeroForcesSPM::m_index

protected

Definition at line 71 of file FilterAeroForcesSPM.h.

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

◆ m_outputFile

std::string Nektar::FilterAeroForcesSPM::m_outputFile

protected

Definition at line 73 of file FilterAeroForcesSPM.h.

Referenced by FilterAeroForcesSPM(), and v_Initialise().

◆ m_outputFrequency

unsigned int Nektar::FilterAeroForcesSPM::m_outputFrequency

protected

Definition at line 72 of file FilterAeroForcesSPM.h.

Referenced by CalculateForces(), FilterAeroForcesSPM(), and v_Update().

◆ m_outputStream

std::ofstream Nektar::FilterAeroForcesSPM::m_outputStream

protected

Definition at line 74 of file FilterAeroForcesSPM.h.

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

◆ m_spaceDim

NekDouble Nektar::FilterAeroForcesSPM::m_spaceDim

protected

Dimension of the fluid domain.

Definition at line 80 of file FilterAeroForcesSPM.h.

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

◆ m_startTime

NekDouble Nektar::FilterAeroForcesSPM::m_startTime

protected

Definition at line 76 of file FilterAeroForcesSPM.h.

Referenced by CalculateForces(), FilterAeroForcesSPM(), and v_Update().

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FilterAeroForcesSPM()

◆ ~FilterAeroForcesSPM()

Member Function Documentation

◆ CalculateForces()

◆ create()

◆ v_Finalise()

◆ v_Initialise()

◆ v_IsTimeDependent()

◆ v_Update()

Friends And Related Function Documentation

◆ MemoryManager< FilterAeroForcesSPM >

Member Data Documentation

◆ className

◆ m_dirNames

◆ m_Forces

◆ m_index

◆ m_outputFile

◆ m_outputFrequency

◆ m_outputStream

◆ m_spaceDim

◆ m_startTime