Nektar::SolverUtils::ForcingNoise Class Reference

#include <ForcingNoise.h>

Inheritance diagram for Nektar::SolverUtils::ForcingNoise:

Static Public Member Functions
static SOLVER_UTILS_EXPORT ForcingSharedPtr	create (const LibUtilities::SessionReaderSharedPtr &pSession, const std::weak_ptr< EquationSystem > &pEquation, const Array< OneD, MultiRegions::ExpListSharedPtr > &pFields, const unsigned int &pNumForcingFields, const TiXmlElement *pForce)
	Creates an instance of this class. More...
Static Public Member Functions inherited from Nektar::SolverUtils::Forcing
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)

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

Protected Member Functions
SOLVER_UTILS_EXPORT void	v_InitObject (const Array< OneD, MultiRegions::ExpListSharedPtr > &pFields, const unsigned int &pNumForcingFields, const TiXmlElement *pForce) override
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) override
Protected Member Functions inherited from Nektar::SolverUtils::Forcing
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)

Private Member Functions
	ForcingNoise (const LibUtilities::SessionReaderSharedPtr &pSession, const std::weak_ptr< EquationSystem > &pEquation)
	~ForcingNoise (void) override

Private Attributes
int	m_index
int	m_updateFreq
int	m_numSteps
NekDouble	m_noise

Friends
class	MemoryManager< ForcingNoise >

Additional Inherited Members
Public Member Functions inherited from Nektar::SolverUtils::Forcing
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 ()
Protected Attributes inherited from Nektar::SolverUtils::Forcing
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

Definition at line 48 of file ForcingNoise.h.

Constructor & Destructor Documentation

ForcingNoise()

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

private

Definition at line 47 of file ForcingNoise.cpp.

    : Forcing(pSession, pEquation)
{
}

~ForcingNoise()

Nektar::SolverUtils::ForcingNoise::~ForcingNoise ( void  )

inlineoverrideprivate

Definition at line 84 of file ForcingNoise.h.

{};

Member Function Documentation

create()

static SOLVER_UTILS_EXPORT ForcingSharedPtr Nektar::SolverUtils::ForcingNoise::create ( const LibUtilities::SessionReaderSharedPtr &  pSession, const std::weak_ptr< EquationSystem > &  pEquation, const Array< OneD, MultiRegions::ExpListSharedPtr > &  pFields, const unsigned int &  pNumForcingFields, const TiXmlElement *  pForce  )

inlinestatic

Creates an instance of this class.

Definition at line 54 of file ForcingNoise.h.

    {
        ForcingSharedPtr p =
            MemoryManager<ForcingNoise>::AllocateSharedPtr(pSession, pEquation);
        p->InitObject(pFields, pNumForcingFields, pForce);
        return p;
    }

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

v_Apply()

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

overrideprotectedvirtual

Implements Nektar::SolverUtils::Forcing.

Definition at line 108 of file ForcingNoise.cpp.

{
    // Do not apply forcing if exceeded m_numSteps
    if (m_numSteps && (m_index >= m_numSteps))
    {
        return;
    }
 
    // Update forcing (change seed to avoid getting same result)
    if (m_updateFreq && m_index && !((m_index) % m_updateFreq))
    {
        for (int i = 0; i < m_NumVariable; ++i)
        {
            Vmath::FillWhiteNoise(outarray[i].size(), m_noise, m_Forcing[i], 1);
        }
    }
 
    // Apply forcing
    for (int i = 0; i < m_NumVariable; i++)
    {
        Vmath::Vadd(outarray[i].size(), outarray[i], 1, m_Forcing[i], 1,
                    outarray[i], 1);
    }
 
    ++m_index;
}

References Vmath::FillWhiteNoise(), Nektar::SolverUtils::Forcing::m_Forcing, m_index, m_noise, m_numSteps, Nektar::SolverUtils::Forcing::m_NumVariable, m_updateFreq, and Vmath::Vadd().

v_InitObject()

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

overrideprotectedvirtual

Implements Nektar::SolverUtils::Forcing.

Definition at line 53 of file ForcingNoise.cpp.

{
    m_NumVariable = pNumForcingFields;
    int nq        = pFields[0]->GetTotPoints();
 
    const TiXmlElement *noiseElmt = pForce->FirstChildElement("WHITENOISE");
    ASSERTL0(noiseElmt, "Requires WHITENOISE tag specifying "
                        "magnitude of white noise force.");
 
    string noiseValue = noiseElmt->GetText();
 
    m_noise = std::stod(noiseValue);
 
    // Load optional parameters
    const TiXmlElement *freqElmt = pForce->FirstChildElement("UPDATEFREQ");
    if (freqElmt)
    {
        string freqValue = freqElmt->GetText();
        m_updateFreq     = boost::lexical_cast<int>(freqValue);
    }
    else
    {
        // Default is 0 (never update forcing)
        m_updateFreq = 0;
    }
 
    const TiXmlElement *stepsElmt = pForce->FirstChildElement("NSTEPS");
    if (stepsElmt)
    {
        string stepsValue = stepsElmt->GetText();
        m_numSteps        = boost::lexical_cast<int>(stepsValue);
    }
    else
    {
        // Default is 0 (use noise in the entire simulation)
        m_numSteps = 0;
    }
 
    m_Forcing = Array<OneD, Array<OneD, NekDouble>>(m_NumVariable);
 
    // Fill forcing: use rank in seed to avoid repeated results
    int seed     = -m_session->GetComm()->GetRank();
    m_Forcing[0] = Array<OneD, NekDouble>(nq, 0.0);
    Vmath::FillWhiteNoise(nq, m_noise, m_Forcing[0], 1, seed);
    for (int i = 1; i < m_NumVariable; ++i)
    {
        m_Forcing[i] = Array<OneD, NekDouble>(nq, 0.0);
        Vmath::FillWhiteNoise(nq, m_noise, m_Forcing[i], 1);
    }
 
    m_index = 0;
}

References ASSERTL0, Vmath::FillWhiteNoise(), Nektar::SolverUtils::Forcing::m_Forcing, m_index, m_noise, m_numSteps, Nektar::SolverUtils::Forcing::m_NumVariable, Nektar::SolverUtils::Forcing::m_session, and m_updateFreq.

Friends And Related Function Documentation

MemoryManager< ForcingNoise >

friend class MemoryManager< ForcingNoise >

friend

Definition at line 1 of file ForcingNoise.h.

Member Data Documentation

className

std::string Nektar::SolverUtils::ForcingNoise::className

static

Initial value:

=
    GetForcingFactory().RegisterCreatorFunction("Noise", ForcingNoise::create,
                                                "White Noise Forcing")

Name of the class.

Definition at line 67 of file ForcingNoise.h.

m_index

int Nektar::SolverUtils::ForcingNoise::m_index

private

Definition at line 86 of file ForcingNoise.h.

Referenced by v_Apply(), and v_InitObject().

m_noise

NekDouble Nektar::SolverUtils::ForcingNoise::m_noise

private

Definition at line 89 of file ForcingNoise.h.

Referenced by v_Apply(), and v_InitObject().

m_numSteps

int Nektar::SolverUtils::ForcingNoise::m_numSteps

private

Definition at line 88 of file ForcingNoise.h.

Referenced by v_Apply(), and v_InitObject().

m_updateFreq

int Nektar::SolverUtils::ForcingNoise::m_updateFreq

private

Definition at line 87 of file ForcingNoise.h.

Referenced by v_Apply(), and v_InitObject().