rotatingAxis Class Reference

Inheritance diagram for rotatingAxis:

Collaboration diagram for rotatingAxis:

Public Member Functions
FUNCTION_HD	rotatingAxis ()
FUNCTION_H	rotatingAxis (const dictionary &dict)
FUNCTION_HD	rotatingAxis (const realx3 &p1, const realx3 &p2, real omega=0.0)
FUNCTION_HD	rotatingAxis (const rotatingAxis &)=default
rotatingAxis &	operator= (const rotatingAxis &)=default
FUNCTION_HD real	setOmega (real omega)
INLINE_FUNCTION_HD real	omega () const
INLINE_FUNCTION_HD bool	isRotating () const
INLINE_FUNCTION_HD realx3	linTangentialVelocityPoint (const realx3 &p) const
FUNCTION_H bool	read (const dictionary &dict)
FUNCTION_H bool	write (dictionary &dict) const
FUNCTION_H bool	read (iIstream &is)
FUNCTION_H bool	write (iOstream &os) const
Public Member Functions inherited from timeInterval
INLINE_FUNCTION_HD	timeInterval ()
INLINE_FUNCTION_HD	timeInterval (const timeInterval &)=default
INLINE_FUNCTION_HD timeInterval &	operator= (const timeInterval &)=default
FUNCTION_H	timeInterval (const dictionary &dict)
INLINE_FUNCTION_HD	~timeInterval ()=default
INLINE_FUNCTION_HD auto	startTime () const
INLINE_FUNCTION_HD auto	endTime () const
INLINE_FUNCTION_HD auto	time () const
INLINE_FUNCTION_HD void	setTime (real t)
INLINE_FUNCTION_HD bool	inTimeRange (real t) const
INLINE_FUNCTION_HD bool	inTimeRange () const
FUNCTION_H bool	read (const dictionary &dict)
FUNCTION_H bool	write (dictionary &dict) const
FUNCTION_H bool	read (iIstream &is)
FUNCTION_H bool	write (iOstream &os) const
Public Member Functions inherited from line
	TypeInfoNV ("line")
FUNCTION_HD	line ()
FUNCTION_HD	line (const realx3 &lp1, const realx3 &lp2)
FUNCTION_H	line (const dictionary &dict)
FUNCTION_HD	line (const line &src)=default
FUNCTION_HD	line (line &&src)=default
FUNCTION_HD line &	operator= (const line &)=default
FUNCTION_HD line &	operator= (line &&)=default
INLINE_FUNCTION_HD void	set (const realx3 &lp1, const realx3 &lp2)
INLINE_FUNCTION_HD realx3	point1 () const
INLINE_FUNCTION_HD realx3	point2 () const
INLINE_FUNCTION_HD realx3	point (real t) const
INLINE_FUNCTION_HD real	length () const
INLINE_FUNCTION_HD realx3	unitVector () const
INLINE_FUNCTION_HD realx3	projectPoint (const realx3 &p) const
INLINE_FUNCTION_HD real	projectNormalizedLength (realx3 p) const
FUNCTION_H bool	read (const dictionary &dict)
FUNCTION_H bool	write (dictionary &ditc) const
FUNCTION_H bool	read (iIstream &is)
FUNCTION_H bool	write (iOstream &os) const

Protected Attributes
real	omega_ = 0
bool	rotating_ = false
Protected Attributes inherited from timeInterval
real	startTime_ = 0
real	endTime_ = largeValue
real	time_ =0
bool	isInInterval_ = true
Protected Attributes inherited from line
realx3	p1_
realx3	v21_

Detailed Description

Definition at line 35 of file rotatingAxis.hpp.

Constructor & Destructor Documentation

rotatingAxis() [1/4]

FUNCTION_HD rotatingAxis ( )

inline

Definition at line 50 of file rotatingAxis.hpp.

rotatingAxis() [2/4]

FUNCTION_H rotatingAxis

(

const dictionary &

dict

)

Definition at line 27 of file rotatingAxis.cpp.

References pFlow::endl(), fatalErrorInFunction, fatalExit, and dictionary::globalName().

Here is the call graph for this function:

rotatingAxis() [3/4]

FUNCTION_HD rotatingAxis	(	const realx3 &	p1,
		const realx3 &	p2,
		real	omega = 0.0
	)

Definition at line 42 of file rotatingAxis.cpp.

rotatingAxis() [4/4]

FUNCTION_HD rotatingAxis ( const rotatingAxis &  )

default

Member Function Documentation

operator=()

rotatingAxis& operator= ( const rotatingAxis &  )

default

setOmega()

FUNCTION_HD pFlow::real setOmega

(

real

omega

)

Definition at line 58 of file rotatingAxis.cpp.

References pFlow::equal(), rotatingAxis::omega(), rotatingAxis::omega_, and rotatingAxis::rotating_.

Here is the call graph for this function:

omega()

INLINE_FUNCTION_HD real omega ( ) const

inline

Definition at line 68 of file rotatingAxis.hpp.

References rotatingAxis::omega_.

Referenced by rotatingAxis::setOmega().

Here is the caller graph for this function:

isRotating()

INLINE_FUNCTION_HD bool isRotating ( ) const

inline

Definition at line 74 of file rotatingAxis.hpp.

References rotatingAxis::rotating_.

Referenced by multiRotatingAxis::transferPoint().

Here is the caller graph for this function:

linTangentialVelocityPoint()

INLINE_FUNCTION_HD pFlow::realx3 linTangentialVelocityPoint

(

const realx3 &

p

)

const

Definition at line 22 of file rotatingAxisI.hpp.

References cross(), timeInterval::inTimeRange(), rotatingAxis::omega_, line::projectPoint(), and line::unitVector().

Referenced by multiRotatingAxis::pointTangentialVel().

Here is the call graph for this function:

Here is the caller graph for this function:

read() [1/2]

FUNCTION_H bool read

(

const dictionary &

dict

)

Definition at line 68 of file rotatingAxis.cpp.

References dictionary::getValOrSet(), timeInterval::read(), and line::read().

Referenced by pFlow::operator>>().

Here is the call graph for this function:

Here is the caller graph for this function:

write() [1/2]

FUNCTION_H bool write

(

dictionary &

dict

)

const

Definition at line 84 of file rotatingAxis.cpp.

References dictionary::add(), pFlow::endl(), fatalErrorInFunction, dictionary::globalName(), timeInterval::write(), and line::write().

Referenced by pFlow::operator<<().

Here is the call graph for this function:

Here is the caller graph for this function:

read() [2/2]

FUNCTION_H bool read

(

iIstream &

is

)

Definition at line 102 of file rotatingAxis.cpp.

References IOstream::check(), pFlow::endl(), FUNCTION_NAME, ioErrorInFile, IOstream::lineNumber(), IOstream::name(), and iIstream::readEndStatement().

Here is the call graph for this function:

write() [2/2]

FUNCTION_H bool write

(

iOstream &

os

)

const

Definition at line 133 of file rotatingAxis.cpp.

References IOstream::check(), FUNCTION_NAME, and iOstream::writeWordEntry().

Here is the call graph for this function:

Member Data Documentation

omega_

real omega_ = 0

protected

Definition at line 43 of file rotatingAxis.hpp.

Referenced by rotatingAxis::linTangentialVelocityPoint(), rotatingAxis::omega(), and rotatingAxis::setOmega().

rotating_

bool rotating_ = false

protected

Definition at line 45 of file rotatingAxis.hpp.

Referenced by rotatingAxis::isRotating(), and rotatingAxis::setOmega().

---

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

• src/MotionModel/entities/rotatingAxis/rotatingAxis.hpp
• src/MotionModel/entities/rotatingAxis/rotatingAxis.cpp
• src/MotionModel/entities/rotatingAxis/rotatingAxisI.hpp