Nektar::SpatialDomains::BoundaryConditionBase Struct Reference

#include <Conditions.h>

Inheritance diagram for Nektar::SpatialDomains::BoundaryConditionBase:

Public Member Functions
	BoundaryConditionBase (BoundaryConditionType type, const std::string &userDefined=std::string("NoUserDefined"), LibUtilities::CommSharedPtr comm=LibUtilities::CommSharedPtr())
virtual	~BoundaryConditionBase ()
BoundaryConditionType	GetBoundaryConditionType () const
void	SetBoundaryConditionType (BoundaryConditionType boundaryType)
void	SetUserDefined (std::string &type)
const std::string	GetUserDefined () const
void	SetIsTimeDependent (bool value)
bool	IsTimeDependent (void)
LibUtilities::CommSharedPtr	GetComm ()

Protected Attributes
BoundaryConditionType	m_boundaryConditionType
std::string	m_userDefined
bool	m_isTimeDependent
LibUtilities::CommSharedPtr	m_comm

Detailed Description

Definition at line 60 of file Conditions.h.

Constructor & Destructor Documentation

BoundaryConditionBase()

Nektar::SpatialDomains::BoundaryConditionBase::BoundaryConditionBase ( BoundaryConditionType  type, const std::string &  userDefined = std::string("NoUserDefined"), LibUtilities::CommSharedPtr  comm = LibUtilities::CommSharedPtr()  )

inline

Definition at line 62 of file Conditions.h.

                                                                             :
                    m_boundaryConditionType(type),
                    m_userDefined(userDefined),
                    m_isTimeDependent(false),
                    m_comm(comm)
            {
            }

~BoundaryConditionBase()

virtual Nektar::SpatialDomains::BoundaryConditionBase::~BoundaryConditionBase ( )

inlinevirtual

Definition at line 73 of file Conditions.h.

            {};

Member Function Documentation

GetBoundaryConditionType()

BoundaryConditionType Nektar::SpatialDomains::BoundaryConditionBase::GetBoundaryConditionType ( ) const

inline

Definition at line 76 of file Conditions.h.

            {
                return m_boundaryConditionType;
            }

References m_boundaryConditionType.

GetComm()

LibUtilities::CommSharedPtr Nektar::SpatialDomains::BoundaryConditionBase::GetComm ( )

inline

Definition at line 106 of file Conditions.h.

            {
                return m_comm;
            }

References m_comm.

GetUserDefined()

const std::string Nektar::SpatialDomains::BoundaryConditionBase::GetUserDefined ( ) const

inline

Definition at line 91 of file Conditions.h.

            {
                return m_userDefined;
            }

References m_userDefined.

IsTimeDependent()

bool Nektar::SpatialDomains::BoundaryConditionBase::IsTimeDependent ( void  )

inline

Definition at line 101 of file Conditions.h.

            {
                return m_isTimeDependent;
            }

References m_isTimeDependent.

SetBoundaryConditionType()

void Nektar::SpatialDomains::BoundaryConditionBase::SetBoundaryConditionType ( BoundaryConditionType  boundaryType )

inline

Definition at line 81 of file Conditions.h.

            {
                m_boundaryConditionType = boundaryType;
            }

References m_boundaryConditionType.

SetIsTimeDependent()

void Nektar::SpatialDomains::BoundaryConditionBase::SetIsTimeDependent ( bool  value )

inline

Definition at line 96 of file Conditions.h.

            {
                m_isTimeDependent = value;
            }

References m_isTimeDependent.

SetUserDefined()

void Nektar::SpatialDomains::BoundaryConditionBase::SetUserDefined ( std::string &  type )

inline

Definition at line 86 of file Conditions.h.

            {
                m_userDefined = type;
            }

References m_userDefined.

Member Data Documentation

m_boundaryConditionType

BoundaryConditionType Nektar::SpatialDomains::BoundaryConditionBase::m_boundaryConditionType

protected

Definition at line 112 of file Conditions.h.

Referenced by GetBoundaryConditionType(), and SetBoundaryConditionType().

m_comm

LibUtilities::CommSharedPtr Nektar::SpatialDomains::BoundaryConditionBase::m_comm

protected

Definition at line 115 of file Conditions.h.

Referenced by GetComm().

m_isTimeDependent

bool Nektar::SpatialDomains::BoundaryConditionBase::m_isTimeDependent

protected

Definition at line 114 of file Conditions.h.

Referenced by IsTimeDependent(), and SetIsTimeDependent().

m_userDefined

std::string Nektar::SpatialDomains::BoundaryConditionBase::m_userDefined

protected

Definition at line 113 of file Conditions.h.

Referenced by GetUserDefined(), and SetUserDefined().