Nektar++
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Member Functions | Friends | List of all members
Nektar::Helmholtz Class Reference

#include <Helmholtz.h>

Inheritance diagram for Nektar::Helmholtz:
Inheritance graph
[legend]
Collaboration diagram for Nektar::Helmholtz:
Collaboration graph
[legend]

Public Member Functions

virtual ~Helmholtz ()
- Public Member Functions inherited from Nektar::Poisson
virtual ~Poisson ()

Static Public Member Functions

static EquationSystemSharedPtr create (const LibUtilities::SessionReaderSharedPtr &pSession)
 Creates an instance of this class.

Static Public Attributes

static std::string className1 = GetEquationSystemFactory().RegisterCreatorFunction("Helmholtz", Helmholtz::create)
 Name of class.
static std::string className2 = GetEquationSystemFactory().RegisterCreatorFunction("SteadyDiffusionReaction", Helmholtz::create)
- Static Public Attributes inherited from Nektar::Poisson
static std::string className1 = GetEquationSystemFactory().RegisterCreatorFunction("Poisson", Poisson::create)
 Name of class.
static std::string className2 = GetEquationSystemFactory().RegisterCreatorFunction("SteadyDiffusion", Poisson::create)
- Static Public Attributes inherited from Nektar::Laplace
static std::string className
 Name of class.

Protected Member Functions

 Helmholtz (const LibUtilities::SessionReaderSharedPtr &pSession)
virtual void v_InitObject ()
 Initialisation object for EquationSystem.
virtual void v_GenerateSummary (SolverUtils::SummaryList &s)
 Virtual function for generating summary information.
- Protected Member Functions inherited from Nektar::Poisson
 Poisson (const LibUtilities::SessionReaderSharedPtr &pSession)
- Protected Member Functions inherited from Nektar::Laplace
 Laplace (const LibUtilities::SessionReaderSharedPtr &pSession)
virtual ~Laplace ()
virtual void v_DoSolve ()
 Virtual function for solve implementation.
- Protected Member Functions inherited from Nektar::SolverUtils::EquationSystem
SOLVER_UTILS_EXPORT EquationSystem (const LibUtilities::SessionReaderSharedPtr &pSession)
 Initialises EquationSystem class members.
int nocase_cmp (const string &s1, const string &s2)
SOLVER_UTILS_EXPORT void SetBoundaryConditions (NekDouble time)
 Evaluates the boundary conditions at the given time.
virtual SOLVER_UTILS_EXPORT void v_DoInitialise ()
 Virtual function for initialisation implementation.
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.
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.
virtual SOLVER_UTILS_EXPORT void v_TransCoeffToPhys ()
 Virtual function for transformation to physical space.
virtual SOLVER_UTILS_EXPORT void v_TransPhysToCoeff ()
 Virtual function for transformation to coefficient space.
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)
SOLVER_UTILS_EXPORT void SetUpBaseFields (SpatialDomains::MeshGraphSharedPtr &mesh)
SOLVER_UTILS_EXPORT void ImportFldBase (std::string pInfile, SpatialDomains::MeshGraphSharedPtr pGraph)
virtual SOLVER_UTILS_EXPORT void v_Output (void)
virtual SOLVER_UTILS_EXPORT
MultiRegions::ExpListSharedPtr 
v_GetPressure (void)
virtual SOLVER_UTILS_EXPORT void v_ExtraFldOutput (std::vector< Array< OneD, NekDouble > > &fieldcoeffs, std::vector< std::string > &variables)

Private Member Functions

virtual Array< OneD, bool > v_GetSystemSingularChecks ()

Friends

class MemoryManager< Helmholtz >

Additional Inherited Members

- Protected Types inherited from Nektar::SolverUtils::EquationSystem
enum  HomogeneousType { eHomogeneous1D, eHomogeneous2D, eHomogeneous3D, eNotHomogeneous }
 Parameter for homogeneous expansions. More...
- Protected Attributes inherited from Nektar::Laplace
StdRegions::ConstFactorMap m_factors

Detailed Description

Definition at line 43 of file Helmholtz.h.

Constructor & Destructor Documentation

Nektar::Helmholtz::~Helmholtz ( )
virtual

Definition at line 58 of file Helmholtz.cpp.

{
}
Nektar::Helmholtz::Helmholtz ( const LibUtilities::SessionReaderSharedPtr pSession)
protected

Definition at line 43 of file Helmholtz.cpp.

References Nektar::StdRegions::eFactorLambda, Nektar::Laplace::m_factors, and Nektar::SolverUtils::EquationSystem::m_session.

: Poisson(pSession)
{
if (pSession->DefinesParameter("Lambda"))
{
m_factors[StdRegions::eFactorLambda] = m_session->GetParameter("Lambda");
}
}

Member Function Documentation

static EquationSystemSharedPtr Nektar::Helmholtz::create ( const LibUtilities::SessionReaderSharedPtr pSession)
inlinestatic

Creates an instance of this class.

Reimplemented from Nektar::Poisson.

Definition at line 49 of file Helmholtz.h.

{
p->InitObject();
return p;
}
void Nektar::Helmholtz::v_GenerateSummary ( SolverUtils::SummaryList l)
protectedvirtual

Virtual function for generating summary information.

Reimplemented from Nektar::Poisson.

Definition at line 63 of file Helmholtz.cpp.

Array< OneD, bool > Nektar::Helmholtz::v_GetSystemSingularChecks ( )
privatevirtual

Definition at line 68 of file Helmholtz.cpp.

References Nektar::StdRegions::eFactorLambda, Nektar::Laplace::m_factors, and Nektar::SolverUtils::EquationSystem::m_session.

{
{
return Array<OneD, bool>(m_session->GetVariables().size(), true);
}
else
{
return Array<OneD, bool>(m_session->GetVariables().size(), false);
}
}
void Nektar::Helmholtz::v_InitObject ( )
protectedvirtual

Initialisation object for EquationSystem.

Continuous field

Setting up the normals

Setting up the normals

Reimplemented from Nektar::Poisson.

Definition at line 53 of file Helmholtz.cpp.

Friends And Related Function Documentation

friend class MemoryManager< Helmholtz >
friend

Definition at line 46 of file Helmholtz.h.

Member Data Documentation

string Nektar::Helmholtz::className1 = GetEquationSystemFactory().RegisterCreatorFunction("Helmholtz", Helmholtz::create)
static

Name of class.

Definition at line 58 of file Helmholtz.h.

string Nektar::Helmholtz::className2 = GetEquationSystemFactory().RegisterCreatorFunction("SteadyDiffusionReaction", Helmholtz::create)
static

Definition at line 59 of file Helmholtz.h.