Nektar::LibUtilities::TimeIntegrationSchemeKey Class Reference

#include <TimeIntegrationScheme.h>

Classes
struct	opLess

Public Member Functions
	TimeIntegrationSchemeKey (const TimeIntegrationMethod &method)
virtual	~TimeIntegrationSchemeKey ()
	TimeIntegrationSchemeKey (const TimeIntegrationSchemeKey &key)
TimeIntegrationSchemeKey &	operator= (const TimeIntegrationSchemeKey &key)
TimeIntegrationMethod	GetIntegrationMethod () const
bool	operator== (const TimeIntegrationSchemeKey &key)
bool	operator== (const TimeIntegrationSchemeKey *y)
bool	operator!= (const TimeIntegrationSchemeKey &y)
bool	operator!= (const TimeIntegrationSchemeKey *y)

Protected Attributes
TimeIntegrationMethod	m_method
	integration method More...

Private Member Functions
	TimeIntegrationSchemeKey ()

Friends
bool	operator== (const TimeIntegrationSchemeKey &lhs, const TimeIntegrationSchemeKey &rhs)
bool	operator< (const TimeIntegrationSchemeKey &lhs, const TimeIntegrationSchemeKey &rhs)
bool	opLess::operator() (const TimeIntegrationSchemeKey &lhs, const TimeIntegrationSchemeKey &rhs) const

Detailed Description

Definition at line 284 of file TimeIntegrationScheme.h.

Constructor & Destructor Documentation

TimeIntegrationSchemeKey() [1/3]

Nektar::LibUtilities::TimeIntegrationSchemeKey::TimeIntegrationSchemeKey ( const TimeIntegrationMethod &  method )

inline

Definition at line 293 of file TimeIntegrationScheme.h.

                                                                         : 
            m_method(method)
            {
            }

~TimeIntegrationSchemeKey()

virtual Nektar::LibUtilities::TimeIntegrationSchemeKey::~TimeIntegrationSchemeKey ( )

inlinevirtual

Definition at line 298 of file TimeIntegrationScheme.h.

            {
            }

TimeIntegrationSchemeKey() [2/3]

Nektar::LibUtilities::TimeIntegrationSchemeKey::TimeIntegrationSchemeKey ( const TimeIntegrationSchemeKey &  key )

inline

Definition at line 302 of file TimeIntegrationScheme.h.

            {
                *this = key; // defer to assignment operator
            }

TimeIntegrationSchemeKey() [3/3]

Nektar::LibUtilities::TimeIntegrationSchemeKey::TimeIntegrationSchemeKey ( )

inlineprivate

Definition at line 348 of file TimeIntegrationScheme.h.

References Nektar::ErrorUtil::efatal, Nektar::LibUtilities::eNoTimeIntegrationMethod, Nektar::lhs, LIB_UTILITIES_EXPORT, NEKERROR, Nektar::LibUtilities::NullTimeIntegrationSchemeKey(), Nektar::LibUtilities::operator<(), Nektar::LibUtilities::operator<<(), Nektar::LibUtilities::operator==(), and Nektar::rhs.

            {
                NEKERROR(ErrorUtil::efatal,"Default Constructor for the TimeIntegrationSchemeKey class should not be called");
            }

Member Function Documentation

GetIntegrationMethod()

TimeIntegrationMethod Nektar::LibUtilities::TimeIntegrationSchemeKey::GetIntegrationMethod ( ) const

inline

Definition at line 314 of file TimeIntegrationScheme.h.

Referenced by Nektar::LibUtilities::operator<<(), and Nektar::LibUtilities::TimeIntegrationScheme::TimeIntegrationScheme().

            {
                return m_method;
            }

operator!=() [1/2]

bool Nektar::LibUtilities::TimeIntegrationSchemeKey::operator!= ( const TimeIntegrationSchemeKey &  y )

inline

Definition at line 329 of file TimeIntegrationScheme.h.

            {
                return (!(*this == y));
            }

operator!=() [2/2]

bool Nektar::LibUtilities::TimeIntegrationSchemeKey::operator!= ( const TimeIntegrationSchemeKey *  y )

inline

Definition at line 334 of file TimeIntegrationScheme.h.

References Nektar::lhs, LIB_UTILITIES_EXPORT, Nektar::LibUtilities::operator<(), Nektar::LibUtilities::operator==(), and Nektar::rhs.

            {
                return (!(*this == *y));
            }

operator=()

TimeIntegrationSchemeKey& Nektar::LibUtilities::TimeIntegrationSchemeKey::operator= ( const TimeIntegrationSchemeKey &  key )

inline

Definition at line 307 of file TimeIntegrationScheme.h.

References m_method.

            {
                m_method  = key.m_method;
                
                return *this;
            }

operator==() [1/2]

bool Nektar::LibUtilities::TimeIntegrationSchemeKey::operator== ( const TimeIntegrationSchemeKey &  key )

inline

Definition at line 319 of file TimeIntegrationScheme.h.

References m_method.

            {
                return (m_method == key.m_method);
            }

operator==() [2/2]

bool Nektar::LibUtilities::TimeIntegrationSchemeKey::operator== ( const TimeIntegrationSchemeKey *  y )

inline

Definition at line 324 of file TimeIntegrationScheme.h.

            {
                return (*this == *y);
            }

Friends And Related Function Documentation

operator<

bool operator< ( const TimeIntegrationSchemeKey &  lhs, const TimeIntegrationSchemeKey &  rhs  )

friend

Definition at line 57 of file TimeIntegrationScheme.cpp.

        {
            return (lhs.m_method < rhs.m_method);
        }

operator==

bool operator== ( const TimeIntegrationSchemeKey &  lhs, const TimeIntegrationSchemeKey &  rhs  )

friend

Definition at line 52 of file TimeIntegrationScheme.cpp.

        {
            return (lhs.m_method == rhs.m_method);
        }

opLess::operator()

bool opLess::operator() ( const TimeIntegrationSchemeKey &  lhs, const TimeIntegrationSchemeKey &  rhs  ) const

friend

Member Data Documentation

m_method

TimeIntegrationMethod Nektar::LibUtilities::TimeIntegrationSchemeKey::m_method

protected

integration method

Definition at line 344 of file TimeIntegrationScheme.h.

Referenced by Nektar::LibUtilities::TimeIntegrationSchemeKey::opLess::operator()(), Nektar::LibUtilities::operator<(), operator=(), Nektar::LibUtilities::operator==(), and operator==().