Nektar::ForcingStabilityCoupledLNS Class Reference

#include <ForcingStabilityCoupledLNS.h>

Inheritance diagram for Nektar::ForcingStabilityCoupledLNS:

Static Public Member Functions
static SolverUtils::ForcingSharedPtr	create (const LibUtilities::SessionReaderSharedPtr &pSession, const std::weak_ptr< SolverUtils::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
virtual void	v_InitObject (const Array< OneD, MultiRegions::ExpListSharedPtr > &pFields, const unsigned int &pNumForcingFields, const TiXmlElement *pForce)
virtual 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)
Protected Member Functions inherited from Nektar::SolverUtils::Forcing
SOLVER_UTILS_EXPORT	Forcing (const LibUtilities::SessionReaderSharedPtr &pSession, const std::weak_ptr< EquationSystem > &pEquation)
	Constructor. More...
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
	ForcingStabilityCoupledLNS (const LibUtilities::SessionReaderSharedPtr &pSession, const std::weak_ptr< SolverUtils::EquationSystem > &pEquation)

Friends
class	MemoryManager< ForcingStabilityCoupledLNS >

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 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 46 of file ForcingStabilityCoupledLNS.h.

Constructor & Destructor Documentation

ForcingStabilityCoupledLNS()

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

private

Definition at line 46 of file ForcingStabilityCoupledLNS.cpp.

    : Forcing(pSession, pEquation)
{
}

Member Function Documentation

create()

static SolverUtils::ForcingSharedPtr Nektar::ForcingStabilityCoupledLNS::create ( const LibUtilities::SessionReaderSharedPtr &  pSession, const std::weak_ptr< SolverUtils::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 53 of file ForcingStabilityCoupledLNS.h.

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

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

v_Apply()

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

protectedvirtual

Implements Nektar::SolverUtils::Forcing.

Definition at line 60 of file ForcingStabilityCoupledLNS.cpp.

References ASSERTL1, and Vmath::Vadd().

{
    int npts = fields[0]->GetTotPoints();
    
    ASSERTL1(fields.num_elements() == outarray.num_elements(),
             "Fields and outarray are of different size");
        
    // Apply m_forcing terms
    for (int i = 0; i < fields.num_elements(); i++)
    {
        Vmath::Vadd(npts, fields[i]->GetPhys(), 1, outarray[i], 1, 
                    outarray[i], 1);
    }

}

v_InitObject()

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

protectedvirtual

Implements Nektar::SolverUtils::Forcing.

Definition at line 53 of file ForcingStabilityCoupledLNS.cpp.

{
}

Friends And Related Function Documentation

MemoryManager< ForcingStabilityCoupledLNS >

friend class MemoryManager< ForcingStabilityCoupledLNS >

friend

Definition at line 50 of file ForcingStabilityCoupledLNS.h.

Member Data Documentation

className

std::string Nektar::ForcingStabilityCoupledLNS::className

static

Initial value:

= SolverUtils::GetForcingFactory().
            RegisterCreatorFunction("StabilityCoupledLNS",
                                    ForcingStabilityCoupledLNS::create,
                                    "RHS forcing for coupled LNS stability solver")

Name of the class.

Definition at line 68 of file ForcingStabilityCoupledLNS.h.