Nektar::Projection Class Reference

#include <Projection.h>

Inheritance diagram for Nektar::Projection:

Static Public Member Functions
static EquationSystemSharedPtr	create (const LibUtilities::SessionReaderSharedPtr &pSession, const SpatialDomains::MeshGraphSharedPtr &pGraph)
	Creates an instance of this class. More...

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

Protected Member Functions
	Projection (const LibUtilities::SessionReaderSharedPtr &pSession, const SpatialDomains::MeshGraphSharedPtr &pGraph)
	~Projection () override=default
void	v_InitObject (bool DeclareFields=true) override
	Initialisation object for EquationSystem. More...
void	v_GenerateSummary (SolverUtils::SummaryList &s) override
	Virtual function for generating summary information. More...
void	v_DoSolve () override
	Virtual function for solve implementation. More...
Protected Member Functions inherited from Nektar::SolverUtils::EquationSystem
SOLVER_UTILS_EXPORT	EquationSystem (const LibUtilities::SessionReaderSharedPtr &pSession, const SpatialDomains::MeshGraphSharedPtr &pGraph)
	Initialises EquationSystem class members. More...
virtual SOLVER_UTILS_EXPORT void	v_InitObject (bool DeclareFeld=true)
	Initialisation object for EquationSystem. More...
virtual SOLVER_UTILS_EXPORT void	v_DoInitialise (bool dumpInitialConditions=true)
	Virtual function for initialisation implementation. More...
virtual SOLVER_UTILS_EXPORT void	v_DoSolve ()
	Virtual function for solve implementation. More...
virtual SOLVER_UTILS_EXPORT NekDouble	v_LinfError (unsigned int field, const Array< OneD, NekDouble > &exactsoln=NullNekDouble1DArray)
	Virtual function for the L_inf error computation between fields and a given exact solution. More...
virtual SOLVER_UTILS_EXPORT NekDouble	v_L2Error (unsigned int field, const Array< OneD, NekDouble > &exactsoln=NullNekDouble1DArray, bool Normalised=false)
	Virtual function for the L_2 error computation between fields and a given exact solution. More...
virtual SOLVER_UTILS_EXPORT NekDouble	v_H1Error (unsigned int field, const Array< OneD, NekDouble > &exactsoln=NullNekDouble1DArray, bool Normalised=false)
	Virtual function for the H_1 error computation between fields and a given exact solution. More...
virtual SOLVER_UTILS_EXPORT void	v_TransCoeffToPhys ()
	Virtual function for transformation to physical space. More...
virtual SOLVER_UTILS_EXPORT void	v_TransPhysToCoeff ()
	Virtual function for transformation to coefficient space. More...
virtual SOLVER_UTILS_EXPORT void	v_GenerateSummary (SummaryList &l)
	Virtual function for generating summary information. More...
virtual SOLVER_UTILS_EXPORT void	v_SetInitialConditions (NekDouble initialtime=0.0, bool dumpInitialConditions=true, const int domain=0)
virtual SOLVER_UTILS_EXPORT void	v_EvaluateExactSolution (unsigned int field, Array< OneD, NekDouble > &outfield, const NekDouble time)
virtual SOLVER_UTILS_EXPORT void	v_Output (void)
virtual SOLVER_UTILS_EXPORT MultiRegions::ExpListSharedPtr	v_GetPressure (void)
virtual SOLVER_UTILS_EXPORT bool	v_NegatedOp (void)
	Virtual function to identify if operator is negated in DoSolve. More...
virtual SOLVER_UTILS_EXPORT void	v_ExtraFldOutput (std::vector< Array< OneD, NekDouble > > &fieldcoeffs, std::vector< std::string > &variables)

Friends
class	MemoryManager< Projection >
	Class may only be instantiated through the MemoryManager. More...

Additional Inherited Members
Public Member Functions inherited from Nektar::SolverUtils::EquationSystem
virtual SOLVER_UTILS_EXPORT	~EquationSystem ()
	Destructor. More...
SOLVER_UTILS_EXPORT void	InitObject (bool DeclareField=true)
	Initialises the members of this object. More...
SOLVER_UTILS_EXPORT void	DoInitialise (bool dumpInitialConditions=true)
	Perform any initialisation necessary before solving the problem. More...
SOLVER_UTILS_EXPORT void	DoSolve ()
	Solve the problem. More...
SOLVER_UTILS_EXPORT void	TransCoeffToPhys ()
	Transform from coefficient to physical space. More...
SOLVER_UTILS_EXPORT void	TransPhysToCoeff ()
	Transform from physical to coefficient space. More...
SOLVER_UTILS_EXPORT void	Output ()
	Perform output operations after solve. More...
SOLVER_UTILS_EXPORT std::string	GetSessionName ()
	Get Session name. More...
template<class T >
std::shared_ptr< T >	as ()
SOLVER_UTILS_EXPORT void	ResetSessionName (std::string newname)
	Reset Session name. More...
SOLVER_UTILS_EXPORT LibUtilities::SessionReaderSharedPtr	GetSession ()
	Get Session name. More...
SOLVER_UTILS_EXPORT MultiRegions::ExpListSharedPtr	GetPressure ()
	Get pressure field if available. More...
SOLVER_UTILS_EXPORT void	ExtraFldOutput (std::vector< Array< OneD, NekDouble > > &fieldcoeffs, std::vector< std::string > &variables)
SOLVER_UTILS_EXPORT void	PrintSummary (std::ostream &out)
	Print a summary of parameters and solver characteristics. More...
SOLVER_UTILS_EXPORT void	SetLambda (NekDouble lambda)
	Set parameter m_lambda. More...
SOLVER_UTILS_EXPORT SessionFunctionSharedPtr	GetFunction (std::string name, const MultiRegions::ExpListSharedPtr &field=MultiRegions::NullExpListSharedPtr, bool cache=false)
	Get a SessionFunction by name. More...
SOLVER_UTILS_EXPORT void	SetInitialConditions (NekDouble initialtime=0.0, bool dumpInitialConditions=true, const int domain=0)
	Initialise the data in the dependent fields. More...
SOLVER_UTILS_EXPORT void	EvaluateExactSolution (int field, Array< OneD, NekDouble > &outfield, const NekDouble time)
	Evaluates an exact solution. More...
SOLVER_UTILS_EXPORT NekDouble	L2Error (unsigned int field, const Array< OneD, NekDouble > &exactsoln, bool Normalised=false)
	Compute the L2 error between fields and a given exact solution. More...
SOLVER_UTILS_EXPORT NekDouble	L2Error (unsigned int field, bool Normalised=false)
	Compute the L2 error of the fields. More...
SOLVER_UTILS_EXPORT NekDouble	LinfError (unsigned int field, const Array< OneD, NekDouble > &exactsoln=NullNekDouble1DArray)
	Linf error computation. More...
SOLVER_UTILS_EXPORT NekDouble	H1Error (unsigned int field, const Array< OneD, NekDouble > &exactsoln, bool Normalised=false)
	Compute the H1 error between fields and a given exact solution. More...
SOLVER_UTILS_EXPORT Array< OneD, NekDouble >	ErrorExtraPoints (unsigned int field)
	Compute error (L2 and L_inf) over an larger set of quadrature points return [L2 Linf]. More...
SOLVER_UTILS_EXPORT void	Checkpoint_Output (const int n)
	Write checkpoint file of m_fields. More...
SOLVER_UTILS_EXPORT void	Checkpoint_Output (const int n, MultiRegions::ExpListSharedPtr &field, std::vector< Array< OneD, NekDouble > > &fieldcoeffs, std::vector< std::string > &variables)
	Write checkpoint file of custom data fields. More...
SOLVER_UTILS_EXPORT void	Checkpoint_BaseFlow (const int n)
	Write base flow file of m_fields. More...
SOLVER_UTILS_EXPORT void	WriteFld (const std::string &outname)
	Write field data to the given filename. More...
SOLVER_UTILS_EXPORT void	WriteFld (const std::string &outname, MultiRegions::ExpListSharedPtr &field, std::vector< Array< OneD, NekDouble > > &fieldcoeffs, std::vector< std::string > &variables)
	Write input fields to the given filename. More...
SOLVER_UTILS_EXPORT void	ImportFld (const std::string &infile, Array< OneD, MultiRegions::ExpListSharedPtr > &pFields)
	Input field data from the given file. More...
SOLVER_UTILS_EXPORT void	ImportFldToMultiDomains (const std::string &infile, Array< OneD, MultiRegions::ExpListSharedPtr > &pFields, const int ndomains)
	Input field data from the given file to multiple domains. More...
SOLVER_UTILS_EXPORT void	ImportFld (const std::string &infile, std::vector< std::string > &fieldStr, Array< OneD, Array< OneD, NekDouble > > &coeffs)
	Output a field. Input field data into array from the given file. More...
SOLVER_UTILS_EXPORT void	ImportFld (const std::string &infile, MultiRegions::ExpListSharedPtr &pField, std::string &pFieldName)
	Output a field. Input field data into ExpList from the given file. More...
SOLVER_UTILS_EXPORT void	SessionSummary (SummaryList &vSummary)
	Write out a session summary. More...
SOLVER_UTILS_EXPORT Array< OneD, MultiRegions::ExpListSharedPtr > &	UpdateFields ()
SOLVER_UTILS_EXPORT LibUtilities::FieldMetaDataMap &	UpdateFieldMetaDataMap ()
	Get hold of FieldInfoMap so it can be updated. More...
SOLVER_UTILS_EXPORT NekDouble	GetTime ()
	Return final time. More...
SOLVER_UTILS_EXPORT int	GetNcoeffs ()
SOLVER_UTILS_EXPORT int	GetNcoeffs (const int eid)
SOLVER_UTILS_EXPORT int	GetNumExpModes ()
SOLVER_UTILS_EXPORT const Array< OneD, int >	GetNumExpModesPerExp ()
SOLVER_UTILS_EXPORT int	GetNvariables ()
SOLVER_UTILS_EXPORT const std::string	GetVariable (unsigned int i)
SOLVER_UTILS_EXPORT int	GetTraceTotPoints ()
SOLVER_UTILS_EXPORT int	GetTraceNpoints ()
SOLVER_UTILS_EXPORT int	GetExpSize ()
SOLVER_UTILS_EXPORT int	GetPhys_Offset (int n)
SOLVER_UTILS_EXPORT int	GetCoeff_Offset (int n)
SOLVER_UTILS_EXPORT int	GetTotPoints ()
SOLVER_UTILS_EXPORT int	GetTotPoints (int n)
SOLVER_UTILS_EXPORT int	GetNpoints ()
SOLVER_UTILS_EXPORT int	GetSteps ()
SOLVER_UTILS_EXPORT void	SetSteps (const int steps)
SOLVER_UTILS_EXPORT NekDouble	GetTimeStep ()
SOLVER_UTILS_EXPORT void	CopyFromPhysField (const int i, Array< OneD, NekDouble > &output)
SOLVER_UTILS_EXPORT void	CopyToPhysField (const int i, const Array< OneD, const NekDouble > &input)
SOLVER_UTILS_EXPORT Array< OneD, NekDouble > &	UpdatePhysField (const int i)
SOLVER_UTILS_EXPORT void	ZeroPhysFields ()
SOLVER_UTILS_EXPORT void	FwdTransFields ()
SOLVER_UTILS_EXPORT void	SetModifiedBasis (const bool modbasis)
SOLVER_UTILS_EXPORT int	GetCheckpointNumber ()
SOLVER_UTILS_EXPORT void	SetCheckpointNumber (int num)
SOLVER_UTILS_EXPORT int	GetCheckpointSteps ()
SOLVER_UTILS_EXPORT void	SetCheckpointSteps (int num)
SOLVER_UTILS_EXPORT int	GetInfoSteps ()
SOLVER_UTILS_EXPORT void	SetInfoSteps (int num)
SOLVER_UTILS_EXPORT void	SetIterationNumberPIT (int num)
SOLVER_UTILS_EXPORT void	SetWindowNumberPIT (int num)
SOLVER_UTILS_EXPORT Array< OneD, const Array< OneD, NekDouble > >	GetTraceNormals ()
SOLVER_UTILS_EXPORT void	SetTime (const NekDouble time)
SOLVER_UTILS_EXPORT void	SetTimeStep (const NekDouble timestep)
SOLVER_UTILS_EXPORT void	SetInitialStep (const int step)
SOLVER_UTILS_EXPORT void	SetBoundaryConditions (NekDouble time)
	Evaluates the boundary conditions at the given time. More...
SOLVER_UTILS_EXPORT bool	NegatedOp ()
	Identify if operator is negated in DoSolve. More...
Protected Types inherited from Nektar::SolverUtils::EquationSystem
enum	HomogeneousType { eHomogeneous1D , eHomogeneous2D , eHomogeneous3D , eNotHomogeneous }
	Parameter for homogeneous expansions. More...
Protected Attributes inherited from Nektar::SolverUtils::EquationSystem
LibUtilities::CommSharedPtr	m_comm
	Communicator. More...
bool	m_verbose
LibUtilities::SessionReaderSharedPtr	m_session
	The session reader. More...
std::map< std::string, SolverUtils::SessionFunctionSharedPtr >	m_sessionFunctions
	Map of known SessionFunctions. More...
LibUtilities::FieldIOSharedPtr	m_fld
	Field input/output. More...
Array< OneD, MultiRegions::ExpListSharedPtr >	m_fields
	Array holding all dependent variables. More...
SpatialDomains::BoundaryConditionsSharedPtr	m_boundaryConditions
	Pointer to boundary conditions object. More...
SpatialDomains::MeshGraphSharedPtr	m_graph
	Pointer to graph defining mesh. More...
std::string	m_sessionName
	Name of the session. More...
NekDouble	m_time
	Current time of simulation. More...
int	m_initialStep
	Number of the step where the simulation should begin. More...
NekDouble	m_fintime
	Finish time of the simulation. More...
NekDouble	m_timestep
	Time step size. More...
NekDouble	m_lambda
	Lambda constant in real system if one required. More...
NekDouble	m_checktime
	Time between checkpoints. More...
NekDouble	m_lastCheckTime
NekDouble	m_TimeIncrementFactor
int	m_nchk
	Number of checkpoints written so far. More...
int	m_steps
	Number of steps to take. More...
int	m_checksteps
	Number of steps between checkpoints. More...
int	m_infosteps
	Number of time steps between outputting status information. More...
int	m_iterPIT = 0
	Number of parallel-in-time time iteration. More...
int	m_windowPIT = 0
	Index of windows for parallel-in-time time iteration. More...
int	m_spacedim
	Spatial dimension (>= expansion dim). More...
int	m_expdim
	Expansion dimension. More...
bool	m_singleMode
	Flag to determine if single homogeneous mode is used. More...
bool	m_halfMode
	Flag to determine if half homogeneous mode is used. More...
bool	m_multipleModes
	Flag to determine if use multiple homogenenous modes are used. More...
bool	m_useFFT
	Flag to determine if FFT is used for homogeneous transform. More...
bool	m_homogen_dealiasing
	Flag to determine if dealiasing is used for homogeneous simulations. More...
bool	m_specHP_dealiasing
	Flag to determine if dealisising is usde for the Spectral/hp element discretisation. More...
enum MultiRegions::ProjectionType	m_projectionType
	Type of projection; e.g continuous or discontinuous. More...
Array< OneD, Array< OneD, NekDouble > >	m_traceNormals
	Array holding trace normals for DG simulations in the forwards direction. More...
Array< OneD, bool >	m_checkIfSystemSingular
	Flag to indicate if the fields should be checked for singularity. More...
LibUtilities::FieldMetaDataMap	m_fieldMetaDataMap
	Map to identify relevant solver info to dump in output fields. More...
Array< OneD, NekDouble >	m_movingFrameData
	Moving reference frame status in the inertial frame X, Y, Z, Theta_x, Theta_y, Theta_z, U, V, W, Omega_x, Omega_y, Omega_z, A_x, A_y, A_z, DOmega_x, DOmega_y, DOmega_z, pivot_x, pivot_y, pivot_z. More...
std::vector< std::string >	m_strFrameData
	variable name in m_movingFrameData More...
int	m_NumQuadPointsError
	Number of Quadrature points used to work out the error. More...
enum HomogeneousType	m_HomogeneousType
NekDouble	m_LhomX
	physical length in X direction (if homogeneous) More...
NekDouble	m_LhomY
	physical length in Y direction (if homogeneous) More...
NekDouble	m_LhomZ
	physical length in Z direction (if homogeneous) More...
int	m_npointsX
	number of points in X direction (if homogeneous) More...
int	m_npointsY
	number of points in Y direction (if homogeneous) More...
int	m_npointsZ
	number of points in Z direction (if homogeneous) More...
int	m_HomoDirec
	number of homogenous directions More...
Static Protected Attributes inherited from Nektar::SolverUtils::EquationSystem
static std::string	equationSystemTypeLookupIds []
static std::string	projectionTypeLookupIds []

Detailed Description

Definition at line 45 of file Projection.h.

Constructor & Destructor Documentation

Projection()

Nektar::Projection::Projection ( const LibUtilities::SessionReaderSharedPtr &  pSession, const SpatialDomains::MeshGraphSharedPtr &  pGraph  )

protected

Definition at line 44 of file Projection.cpp.

    : EquationSystem(pSession, pGraph)
{
}

~Projection()

Nektar::Projection::~Projection ( )

overrideprotecteddefault

Member Function Documentation

create()

static EquationSystemSharedPtr Nektar::Projection::create ( const LibUtilities::SessionReaderSharedPtr &  pSession, const SpatialDomains::MeshGraphSharedPtr &  pGraph  )

inlinestatic

Creates an instance of this class.

Definition at line 52 of file Projection.h.

    {
        EquationSystemSharedPtr p =
            MemoryManager<Projection>::AllocateSharedPtr(pSession, pGraph);
        p->InitObject();
        return p;
    }

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

v_DoSolve()

void Nektar::Projection::v_DoSolve ( void  )

overrideprotectedvirtual

Virtual function for solve implementation.

Reimplemented from Nektar::SolverUtils::EquationSystem.

Definition at line 57 of file Projection.cpp.

{
    for (int i = 0; i < m_fields.size(); ++i)
    {
        // Zero initial guess
        Vmath::Zero(m_fields[i]->GetNcoeffs(), m_fields[i]->UpdateCoeffs(), 1);
        m_fields[i]->FwdTrans(m_fields[i]->GetPhys(),
                              m_fields[i]->UpdateCoeffs());
        m_fields[i]->SetPhysState(false);
    }
}

References Nektar::SolverUtils::EquationSystem::GetNcoeffs(), Nektar::SolverUtils::EquationSystem::m_fields, and Vmath::Zero().

v_GenerateSummary()

void Nektar::Projection::v_GenerateSummary ( SolverUtils::SummaryList &  l )

overrideprotectedvirtual

Virtual function for generating summary information.

Reimplemented from Nektar::SolverUtils::EquationSystem.

Definition at line 69 of file Projection.cpp.

{
    EquationSystem::SessionSummary(s);
    for (int i = 0; i < m_fields.size(); ++i)
    {
        std::stringstream name;
        name << "Forcing func [" << i << "]";
        SolverUtils::AddSummaryItem(
            s, name.str(),
            m_session->GetFunction("Forcing", i)->GetExpression());
    }
}

References Nektar::SolverUtils::AddSummaryItem(), Nektar::SolverUtils::EquationSystem::m_fields, Nektar::SolverUtils::EquationSystem::m_session, CellMLToNektar.pycml::name, and Nektar::SolverUtils::EquationSystem::SessionSummary().

v_InitObject()

void Nektar::Projection::v_InitObject ( bool  DeclareFeld = true )

overrideprotectedvirtual

Initialisation object for EquationSystem.

Continuous field

Setting up the normals

Setting up the normals

Reimplemented from Nektar::SolverUtils::EquationSystem.

Definition at line 50 of file Projection.cpp.

{
    EquationSystem::v_InitObject(DeclareFields);
 
    GetFunction("Forcing")->Evaluate(m_session->GetVariables(), m_fields);
}

References Nektar::SolverUtils::EquationSystem::GetFunction(), Nektar::SolverUtils::EquationSystem::m_fields, Nektar::SolverUtils::EquationSystem::m_session, and Nektar::SolverUtils::EquationSystem::v_InitObject().

Friends And Related Function Documentation

MemoryManager< Projection >

friend class MemoryManager< Projection >

friend

Class may only be instantiated through the MemoryManager.

Definition at line 1 of file Projection.h.

Member Data Documentation

className

std::string Nektar::Projection::className

static

Initial value:

=
    GetEquationSystemFactory().RegisterCreatorFunction("Projection",
                                                       Projection::create)

Name of class.

Definition at line 63 of file Projection.h.