AttribINSFVMomentumResidualObject Class Reference

An attribute specifying that an object is a residual object applicable to the Navier-Stokes momentum equation for incompressible or weakly compressible flows. More...

#include <INSFVAttributes.h>

Inheritance diagram for AttribINSFVMomentumResidualObject:

Public Types
typedef bool	Key

Public Member Functions
void	setFrom (const Key k)
	AttribINSFVMomentumResidualObject (TheWarehouse &w)
	AttribINSFVMomentumResidualObject (TheWarehouse &w, Key k)
void	initFrom (const MooseObject *obj) override
bool	isMatch (const Attribute &other) const override
bool	isEqual (const Attribute &other) const override
	hashfunc (_val)
	clonefunc (AttribINSFVMomentumResidualObject)
bool	operator== (const Attribute &other) const
bool	operator!= (const Attribute &other) const
unsigned int	id () const
virtual std::size_t	hash () const=0
virtual std::unique_ptr< Attribute >	clone () const=0

Private Attributes
Key	_val
int	_id

Detailed Description

An attribute specifying that an object is a residual object applicable to the Navier-Stokes momentum equation for incompressible or weakly compressible flows.

Definition at line 68 of file INSFVAttributes.h.

Member Typedef Documentation

Key

typedef bool AttribINSFVMomentumResidualObject::Key

Definition at line 71 of file INSFVAttributes.h.

Constructor & Destructor Documentation

AttribINSFVMomentumResidualObject() [1/2]

AttribINSFVMomentumResidualObject::AttribINSFVMomentumResidualObject ( TheWarehouse &  w )

inline

Definition at line 73 of file INSFVAttributes.h.

    : Attribute(w, "insfv_residual_object"), _val(false)
  {
  }

AttribINSFVMomentumResidualObject() [2/2]

AttribINSFVMomentumResidualObject::AttribINSFVMomentumResidualObject ( TheWarehouse &  w, Key  k  )

inline

Definition at line 77 of file INSFVAttributes.h.

    : Attribute(w, "insfv_residual_object"), _val(k)
  {
  }

Member Function Documentation

clonefunc()

AttribINSFVMomentumResidualObject::clonefunc

(

AttribINSFVMomentumResidualObject

)

hashfunc()

AttribINSFVMomentumResidualObject::hashfunc

(

_val

)

initFrom()

void AttribINSFVMomentumResidualObject::initFrom ( const MooseObject *  obj )

overridevirtual

Implements Attribute.

Definition at line 48 of file INSFVAttributes.C.

{
  _val = dynamic_cast<const INSFVMomentumResidualObject *>(obj);
}

isEqual()

bool AttribINSFVMomentumResidualObject::isEqual ( const Attribute &  other ) const

overridevirtual

Implements Attribute.

Definition at line 61 of file INSFVAttributes.C.

{
  auto a = dynamic_cast<const AttribINSFVMomentumResidualObject *>(&other);
  return a && (a->_val == _val);
}

isMatch()

bool AttribINSFVMomentumResidualObject::isMatch ( const Attribute &  other ) const

overridevirtual

Implements Attribute.

Definition at line 54 of file INSFVAttributes.C.

{
  auto a = dynamic_cast<const AttribINSFVMomentumResidualObject *>(&other);
  return a && (a->_val == _val);
}

setFrom()

void AttribINSFVMomentumResidualObject::setFrom ( const Key  k )

inline

Definition at line 72 of file INSFVAttributes.h.

{ _val = k; }

Member Data Documentation

_val

Key AttribINSFVMomentumResidualObject::_val

private

Definition at line 88 of file INSFVAttributes.h.

Referenced by initFrom(), isEqual(), isMatch(), and setFrom().

---

The documentation for this class was generated from the following files:

• navier_stokes/include/base/INSFVAttributes.h
• navier_stokes/src/base/INSFVAttributes.C