State Class Reference

An abstract class for the initialization of the state of fluid objects. More...

#include <state.h>

Inheritance diagram for State:

Public Member Functions
virtual double	pressure (double x, double y, double z)=0
	Calculates pressure based on the Cartesian coordinate (x,y,z) of a particle. More...
virtual double	density (double x, double y, double z)=0
	Calculates density based on the Cartesian coordinate (x,y,z) of a particle. More...
virtual void	velocity (double x, double y, double z, double &vX, double &vY, double &vZ)=0
	Calculates velocity based on the Cartesian coordinate (x,y,z) of a particle. More...
virtual	~State ()
	Destructor.

Detailed Description

An abstract class for the initialization of the state of fluid objects.

The specified states include pressure, density, and velocity. These states are assigned based on the initial Cartesian coordinate of particles ( , , ).

Note

Author

Chen, Hsin-Chiang (morri.nosp@m.sche.nosp@m.n2008.nosp@m.@gma.nosp@m.il.co.nosp@m.m)

Version

1.0

Date

2014/08/08

Created on: 2014/06/07

Member Function Documentation

virtual double State::density ( double  x, double  y, double  z  )

pure virtual

Calculates density based on the Cartesian coordinate (x,y,z) of a particle.

Parameters

[in]	x	The x-coordinate
[in]	y	The y-coordinate
[in]	z	The z-coordinate

Returns

The calculated density value

Implemented in UniformVelocityState, RightUniformVelocityState, GaussianPressureState, GaussianPressure1DState, and LeftUniformVelocityState.

virtual double State::pressure ( double  x, double  y, double  z  )

pure virtual

Calculates pressure based on the Cartesian coordinate (x,y,z) of a particle.

Parameters

[in]	x	The x-coordinate
[in]	y	The y-coordinate
[in]	z	The z-coordinate

Returns

The calculated pressure value

Implemented in UniformVelocityState, RightUniformVelocityState, GaussianPressureState, GaussianPressure1DState, and LeftUniformVelocityState.

virtual void State::velocity ( double  x, double  y, double  z, double &  vX, double &  vY, double &  vZ  )

pure virtual

Calculates velocity based on the Cartesian coordinate (x,y,z) of a particle.

Parameters

[in]	x	The x-coordinate
[in]	y	The y-coordinate
[in]	z	The z-coordinate
[out]	vX	The calculated velocity value in x-coordinate
[out]	vY	The calculated velocity value in y-coordinate
[out]	vZ	The calculated velocity value in z-coordinate

Returns

None

Implemented in UniformVelocityState, RightUniformVelocityState, GaussianPressureState, GaussianPressure1DState, and LeftUniformVelocityState.

---

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

• state.h