Defines a forcing term to be explicitly applied. More...

#include <Forcing.h>

Inheritance diagram for Nektar::SolverUtils::Forcing:

Public Member Functions
virtual SOLVER_UTILS_EXPORT	~Forcing ()

SOLVER_UTILS_EXPORT void	InitObject (const Array< OneD, MultiRegions::ExpListSharedPtr > &pFields, const unsigned int &pNumForcingFields, const TiXmlElement *pForce)
	Initialise the forcing object. More...

SOLVER_UTILS_EXPORT void	Apply (const Array< OneD, MultiRegions::ExpListSharedPtr > &fields, const Array< OneD, Array< OneD, NekDouble > > &inarray, Array< OneD, Array< OneD, NekDouble > > &outarray, const NekDouble &time)
	Apply the forcing. More...

SOLVER_UTILS_EXPORT void	PreApply (const Array< OneD, MultiRegions::ExpListSharedPtr > &fields, const Array< OneD, Array< OneD, NekDouble > > &inarray, Array< OneD, Array< OneD, NekDouble > > &outarray, const NekDouble &time)
	Change the advection velocity before applying the forcing. For example, subtracting the frame velocity from the advection velocity in the MovingRefercenceFrame. More...

SOLVER_UTILS_EXPORT void	ApplyCoeff (const Array< OneD, MultiRegions::ExpListSharedPtr > &fields, const Array< OneD, Array< OneD, NekDouble > > &inarray, Array< OneD, Array< OneD, NekDouble > > &outarray, const NekDouble &time)
	Apply the forcing. More...

SOLVER_UTILS_EXPORT const Array< OneD, const Array< OneD, NekDouble > > &	GetForces ()

SOLVER_UTILS_EXPORT Array< OneD, Array< OneD, NekDouble > > &	UpdateForces ()

Static Public Member Functions
static SOLVER_UTILS_EXPORT std::vector< ForcingSharedPtr >	Load (const LibUtilities::SessionReaderSharedPtr &pSession, const std::weak_ptr< EquationSystem > &pEquation, const Array< OneD, MultiRegions::ExpListSharedPtr > &pFields, const unsigned int &pNumForcingFields=0)

Protected Member Functions
SOLVER_UTILS_EXPORT	Forcing (const LibUtilities::SessionReaderSharedPtr &pSession, const std::weak_ptr< EquationSystem > &pEquation)
	Constructor. More...

virtual SOLVER_UTILS_EXPORT void	v_InitObject (const Array< OneD, MultiRegions::ExpListSharedPtr > &pFields, const unsigned int &pNumForcingFields, const TiXmlElement *pForce)=0

virtual SOLVER_UTILS_EXPORT void	v_Apply (const Array< OneD, MultiRegions::ExpListSharedPtr > &fields, const Array< OneD, Array< OneD, NekDouble > > &inarray, Array< OneD, Array< OneD, NekDouble > > &outarray, const NekDouble &time)=0

virtual SOLVER_UTILS_EXPORT void	v_PreApply (const Array< OneD, MultiRegions::ExpListSharedPtr > &fields, const Array< OneD, Array< OneD, NekDouble > > &inarray, Array< OneD, Array< OneD, NekDouble > > &outarray, const NekDouble &time)

virtual SOLVER_UTILS_EXPORT void	v_ApplyCoeff (const Array< OneD, MultiRegions::ExpListSharedPtr > &fields, const Array< OneD, Array< OneD, NekDouble > > &inarray, Array< OneD, Array< OneD, NekDouble > > &outarray, const NekDouble &time)

SOLVER_UTILS_EXPORT SessionFunctionSharedPtr	GetFunction (const Array< OneD, MultiRegions::ExpListSharedPtr > &pFields, const LibUtilities::SessionReaderSharedPtr &pSession, std::string pName, bool pCache=false)
	Get a SessionFunction by name. More...

SOLVER_UTILS_EXPORT void	EvaluateTimeFunction (LibUtilities::SessionReaderSharedPtr pSession, std::string pFieldName, Array< OneD, NekDouble > &pArray, const std::string &pFunctionName, NekDouble pTime=NekDouble(0))

SOLVER_UTILS_EXPORT void	EvaluateTimeFunction (const NekDouble pTime, const LibUtilities::EquationSharedPtr &pEqn, Array< OneD, NekDouble > &pArray)

Protected Attributes
LibUtilities::SessionReaderSharedPtr	m_session
	Session reader. More...

const std::weak_ptr< EquationSystem >	m_equ
	Weak pointer to equation system using this forcing. More...

Array< OneD, Array< OneD, NekDouble > >	m_Forcing
	Evaluated forcing function. More...

int	m_NumVariable
	Number of variables. More...

std::map< std::string, SolverUtils::SessionFunctionSharedPtr >	m_sessionFunctions
	Map of known SessionFunctions. More...

Detailed Description

Defines a forcing term to be explicitly applied.

Definition at line 70 of file Forcing.h.

Constructor & Destructor Documentation

◆ ~Forcing()

virtual SOLVER_UTILS_EXPORT Nektar::SolverUtils::Forcing::~Forcing ( )

inlinevirtual

Definition at line 73 of file Forcing.h.

74 {

75 }

◆ Forcing()

Nektar::SolverUtils::Forcing::Forcing	(	const LibUtilities::SessionReaderSharedPtr &	pSession,
		const std::weak_ptr< EquationSystem > &	pEquation
	)

protected

Constructor.

Definition at line 48 of file Forcing.cpp.

    : m_session(pSession), m_equ(pEquation)
{
}

Member Function Documentation

◆ Apply()

void Nektar::SolverUtils::Forcing::Apply	(	const Array< OneD, MultiRegions::ExpListSharedPtr > &	fields,
		const Array< OneD, Array< OneD, NekDouble > > &	inarray,
		Array< OneD, Array< OneD, NekDouble > > &	outarray,
		const NekDouble &	time
	)

Apply the forcing.

Parameters

fields	Expansion lists corresponding to input arrays
inarray	u^n from previous timestep
outarray	output array to append forcing to

Definition at line 66 of file Forcing.cpp.

{
    v_Apply(fields, inarray, outarray, time);
}

References v_Apply().

◆ ApplyCoeff()

void Nektar::SolverUtils::Forcing::ApplyCoeff	(	const Array< OneD, MultiRegions::ExpListSharedPtr > &	fields,
		const Array< OneD, Array< OneD, NekDouble > > &	inarray,
		Array< OneD, Array< OneD, NekDouble > > &	outarray,
		const NekDouble &	time
	)

Apply the forcing.

Parameters

fields	Expansion lists corresponding to input arrays
inarray	u^n from previous timestep
outarray	output array to append forcing to

Definition at line 107 of file Forcing.cpp.

{
    v_ApplyCoeff(fields, inarray, outarray, time);
}

References v_ApplyCoeff().

◆ EvaluateTimeFunction() [1/2]

void Nektar::SolverUtils::Forcing::EvaluateTimeFunction	(	const NekDouble	pTime,
		const LibUtilities::EquationSharedPtr &	pEqn,
		Array< OneD, NekDouble > &	pArray
	)

protected

Definition at line 182 of file Forcing.cpp.

{
    // dummy array of zero pts.
    Array<OneD, NekDouble> x0(pArray.size(), 0.0);
 
    pEqn->Evaluate(x0, x0, x0, pTime, pArray);
}

◆ EvaluateTimeFunction() [2/2]

void Nektar::SolverUtils::Forcing::EvaluateTimeFunction	(	LibUtilities::SessionReaderSharedPtr	pSession,
		std::string	pFieldName,
		Array< OneD, NekDouble > &	pArray,
		const std::string &	pFunctionName,
		NekDouble	pTime = `NekDouble(0)`
	)

protected

Definition at line 168 of file Forcing.cpp.

{
    ASSERTL0(pSession->DefinesFunction(pFunctionName),
             "Function '" + pFunctionName + "' does not exist.");
 
    LibUtilities::EquationSharedPtr ffunc =
        pSession->GetFunction(pFunctionName, pFieldName);
 
    EvaluateTimeFunction(pTime, ffunc, pArray);
}

References ASSERTL0, and EvaluateTimeFunction().

Referenced by EvaluateTimeFunction(), Nektar::SolverUtils::ForcingBody::v_Apply(), and Nektar::SolverUtils::ForcingBody::v_ApplyCoeff().

◆ GetForces()

const Nektar::Array< OneD, const Array< OneD, NekDouble > > & Nektar::SolverUtils::Forcing::GetForces ( )

Definition at line 163 of file Forcing.cpp.

{
    return m_Forcing;
}

References m_Forcing.

◆ GetFunction()

SessionFunctionSharedPtr Nektar::SolverUtils::Forcing::GetFunction	(	const Array< OneD, MultiRegions::ExpListSharedPtr > &	pFields,
		const LibUtilities::SessionReaderSharedPtr &	pSession,
		std::string	pName,
		bool	pCache = `false`
	)

protected

Get a SessionFunction by name.

Definition at line 192 of file Forcing.cpp.

{
    if (pCache)
    {
        if ((m_sessionFunctions.find(pName) == m_sessionFunctions.end()) ||
            (m_sessionFunctions[pName]->GetSession() != pSession) ||
            (m_sessionFunctions[pName]->GetExpansion() != pFields[0]))
        {
            m_sessionFunctions[pName] =
                MemoryManager<SessionFunction>::AllocateSharedPtr(
                    pSession, pFields[0], pName, pCache);
        }
 
        return m_sessionFunctions[pName];
    }
    else
    {
        return SessionFunctionSharedPtr(
            new SessionFunction(pSession, pFields[0], pName, pCache));
    }
}

References Nektar::MemoryManager< DataType >::AllocateSharedPtr(), and m_sessionFunctions.

Referenced by Nektar::SolverUtils::ForcingAbsorption::CalcAbsorption(), Nektar::SolverUtils::ForcingAbsorption::CalculateForcing(), Nektar::SolverUtils::ForcingBody::Update(), Nektar::ForcingMovingBody::v_Apply(), Nektar::SolverUtils::ForcingAbsorption::v_InitObject(), and Nektar::ForcingQuasi1D::v_InitObject().

◆ InitObject()

void Nektar::SolverUtils::Forcing::InitObject	(	const Array< OneD, MultiRegions::ExpListSharedPtr > &	pFields,
		const unsigned int &	pNumForcingFields,
		const TiXmlElement *	pForce
	)

Initialise the forcing object.

Definition at line 54 of file Forcing.cpp.

{
    v_InitObject(pFields, pNumForcingFields, pForce);
}

References v_InitObject().

◆ Load()

vector< ForcingSharedPtr > Nektar::SolverUtils::Forcing::Load	(	const LibUtilities::SessionReaderSharedPtr &	pSession,
		const std::weak_ptr< EquationSystem > &	pEquation,
		const Array< OneD, MultiRegions::ExpListSharedPtr > &	pFields,
		const unsigned int &	pNumForcingFields = `0`
	)

static

Definition at line 118 of file Forcing.cpp.

{
    vector<ForcingSharedPtr> vForceList;
 
    if (!pSession->DefinesElement("Nektar/Forcing"))
    {
        return vForceList;
    }
 
    TiXmlElement *vForcing = pSession->GetElement("Nektar/Forcing");
    if (vForcing)
    {
        unsigned int vNumForcingFields = pNumForcingFields;
        if (!pNumForcingFields)
        {
            vNumForcingFields = pFields.size();
        }
 
        TiXmlElement *vForce = vForcing->FirstChildElement("FORCE");
        while (vForce)
        {
            string vType = vForce->Attribute("TYPE");
 
            TiXmlElement *vForceParam = vForce;
            LibUtilities::SessionReader::GetXMLElementTimeLevel(
                vForceParam, pSession->GetTimeLevel(), false);
            vForceList.push_back(GetForcingFactory().CreateInstance(
                vType, pSession, pEquation, pFields, vNumForcingFields,
                vForceParam));
 
            vForce = vForce->NextSiblingElement("FORCE");
        }
    }
    return vForceList;
}

References Nektar::SolverUtils::GetForcingFactory(), and Nektar::LibUtilities::SessionReader::GetXMLElementTimeLevel().

Referenced by Nektar::IncNavierStokes::v_InitObject(), Nektar::AcousticSystem::v_InitObject(), Nektar::UnsteadyAdvection::v_InitObject(), Nektar::UnsteadyInviscidBurgers::v_InitObject(), Nektar::UnsteadyReactionDiffusion::v_InitObject(), Nektar::CompressibleFlowSystem::v_InitObject(), and Nektar::Dummy::v_InitObject().

◆ PreApply()

void Nektar::SolverUtils::Forcing::PreApply	(	const Array< OneD, MultiRegions::ExpListSharedPtr > &	fields,
		const Array< OneD, Array< OneD, NekDouble > > &	inarray,
		Array< OneD, Array< OneD, NekDouble > > &	outarray,
		const NekDouble &	time
	)

Change the advection velocity before applying the forcing. For example, subtracting the frame velocity from the advection velocity in the MovingRefercenceFrame.

Definition at line 74 of file Forcing.cpp.

{
    v_PreApply(fields, inarray, outarray, time);
}

References v_PreApply().

◆ UpdateForces()

Nektar::Array< OneD, Array< OneD, NekDouble > > & Nektar::SolverUtils::Forcing::UpdateForces ( )

Definition at line 158 of file Forcing.cpp.

{
    return m_Forcing;
}

References m_Forcing.

◆ v_Apply()

virtual SOLVER_UTILS_EXPORT void Nektar::SolverUtils::Forcing::v_Apply	(	const Array< OneD, MultiRegions::ExpListSharedPtr > &	fields,
		const Array< OneD, Array< OneD, NekDouble > > &	inarray,
		Array< OneD, Array< OneD, NekDouble > > &	outarray,
		const NekDouble &	time
	)

protectedpure virtual

Implemented in Nektar::SolverUtils::ForcingAbsorption, Nektar::SolverUtils::ForcingBody, Nektar::SolverUtils::ForcingMovingReferenceFrame, Nektar::SolverUtils::ForcingNoise, Nektar::SolverUtils::ForcingProgrammatic, Nektar::ForcingAxiSymmetric, Nektar::ForcingQuasi1D, Nektar::ForcingMovingBody, and Nektar::ForcingStabilityCoupledLNS.

Referenced by Apply().

◆ v_ApplyCoeff()

void Nektar::SolverUtils::Forcing::v_ApplyCoeff	(	const Array< OneD, MultiRegions::ExpListSharedPtr > &	fields,
		const Array< OneD, Array< OneD, NekDouble > > &	inarray,
		Array< OneD, Array< OneD, NekDouble > > &	outarray,
		const NekDouble &	time
	)

protectedvirtual

Reimplemented in Nektar::SolverUtils::ForcingAbsorption, and Nektar::SolverUtils::ForcingBody.

Definition at line 217 of file Forcing.cpp.

{
    ASSERTL0(false, "v_ApplyCoeff not defined");
}

References ASSERTL0.

Referenced by ApplyCoeff().

◆ v_InitObject()

virtual SOLVER_UTILS_EXPORT void Nektar::SolverUtils::Forcing::v_InitObject	(	const Array< OneD, MultiRegions::ExpListSharedPtr > &	pFields,
		const unsigned int &	pNumForcingFields,
		const TiXmlElement *	pForce
	)

protectedpure virtual

Implemented in Nektar::SolverUtils::ForcingAbsorption, Nektar::SolverUtils::ForcingBody, Nektar::SolverUtils::ForcingMovingReferenceFrame, Nektar::SolverUtils::ForcingNoise, Nektar::SolverUtils::ForcingProgrammatic, Nektar::ForcingAxiSymmetric, Nektar::ForcingQuasi1D, Nektar::ForcingMovingBody, and Nektar::ForcingStabilityCoupledLNS.

Referenced by InitObject().

◆ v_PreApply()

void Nektar::SolverUtils::Forcing::v_PreApply	(	const Array< OneD, MultiRegions::ExpListSharedPtr > &	fields,
		const Array< OneD, Array< OneD, NekDouble > > &	inarray,
		Array< OneD, Array< OneD, NekDouble > > &	outarray,
		const NekDouble &	time
	)

protectedvirtual

Reimplemented in Nektar::SolverUtils::ForcingMovingReferenceFrame.

Definition at line 82 of file Forcing.cpp.

{
    if (&inarray != &outarray)
    {
        int nvar = std::min(inarray.size(), outarray.size());
        for (int i = 0; i < nvar; ++i)
        {
            if (&inarray[i] != &outarray[i])
            {
                int np = std::min(inarray[i].size(), outarray[i].size());
                Vmath::Vcopy(np, inarray[i], 1, outarray[i], 1);
            }
        }
    }
}

References Vmath::Vcopy().

Referenced by PreApply().

Member Data Documentation

◆ m_equ

const std::weak_ptr<EquationSystem> Nektar::SolverUtils::Forcing::m_equ

protected

Weak pointer to equation system using this forcing.

Definition at line 117 of file Forcing.h.

Referenced by Nektar::SolverUtils::ForcingMovingReferenceFrame::InitialiseFilter(), Nektar::ForcingMovingBody::InitialiseFilter(), Nektar::SolverUtils::ForcingMovingReferenceFrame::Update(), Nektar::SolverUtils::ForcingMovingReferenceFrame::UpdateBoundaryConditions(), and Nektar::SolverUtils::ForcingMovingReferenceFrame::v_InitObject().

◆ m_Forcing

Array<OneD, Array<OneD, NekDouble> > Nektar::SolverUtils::Forcing::m_Forcing

protected

Evaluated forcing function.

Definition at line 119 of file Forcing.h.

◆ m_NumVariable

int Nektar::SolverUtils::Forcing::m_NumVariable

protected

Number of variables.

Definition at line 121 of file Forcing.h.

◆ m_session

LibUtilities::SessionReaderSharedPtr Nektar::SolverUtils::Forcing::m_session

protected

Session reader.

Definition at line 115 of file Forcing.h.

◆ m_sessionFunctions

std::map<std::string, SolverUtils::SessionFunctionSharedPtr> Nektar::SolverUtils::Forcing::m_sessionFunctions

protected

Map of known SessionFunctions.

Definition at line 124 of file Forcing.h.

Referenced by GetFunction().

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ~Forcing()

◆ Forcing()

Member Function Documentation

◆ Apply()

◆ ApplyCoeff()

◆ EvaluateTimeFunction() [1/2]

◆ EvaluateTimeFunction() [2/2]

◆ GetForces()

◆ GetFunction()

◆ InitObject()

◆ Load()

◆ PreApply()

◆ UpdateForces()

◆ v_Apply()

◆ v_ApplyCoeff()

◆ v_InitObject()

◆ v_PreApply()

Member Data Documentation

◆ m_equ

◆ m_Forcing

◆ m_NumVariable

◆ m_session

◆ m_sessionFunctions