#include <Nsound/MeshJunction.h>

Public Member Functions
	MeshJunction (const float64 &leak_gain, const float64 &tau, const float64 &delta, const float64 &gamma)
	Constructor. More...

	MeshJunction (const MeshJunction &copy)
	This operator can not assign neighbor pointers. More...

	~MeshJunction ()
	Deconstructor. More...

void	clear ()
	Clears all velicityes in the junctino. More...

float64	getVelocity () const

MeshJunction &	operator= (const MeshJunction &rhs)
	This operator can not assign neighbor pointers. More...

void	setNeighborNorth (MeshJunction *ptr)

void	setNeighborSouth (MeshJunction *ptr)

void	setNeighborEast (MeshJunction *ptr)

void	setNeighborWest (MeshJunction *ptr)

void	saveState ()
	Saves previous south and east velocities. More...

void	strike (const float64 &velocity)
	Adds velocity to this junction. More...

void	updateVelocity ()
	updates junction velocity. More...

Private Member Functions
void	updateBoundry ()

Private Attributes
float64	leak_gain_
	updates junction velocity. More...

float64	velocity_
	Leak gain. More...

float64	velocity_north_
	This junction's velocity. More...

float64	velocity_south_
	Velocity going north. More...

float64	velocity_east_
	Velocity going south. More...

float64	velocity_west_
	Velocity going east. More...

float64	previous_velocity_
	Velocity going west. More...

float64	previous_velocity_north_

float64	previous_velocity_south_

float64	previous_velocity_east_

float64	previous_velocity_west_

float64	vc_

float64	yj_

float64	yc_

MeshJunction *	neighbor_north_

MeshJunction *	neighbor_south_

MeshJunction *	neighbor_east_

MeshJunction *	neighbor_west_

Detailed Description

WARNING: This is Experimental, you should not use this class as it may not be working or will change in future releases of Nsound.

Definition at line 47 of file MeshJunction.h.

Constructor & Destructor Documentation

MeshJunction::MeshJunction	(	const float64 &	leak_gain,
		const float64 &	tau,
		const float64 &	delta,
		const float64 &	gamma
	)

Constructor.

Definition at line 41 of file MeshJunction.cc.

References leak_gain_, yc_, and yj_.

     :
     leak_gain_(leak_gain),
     velocity_(0.0),
     velocity_north_(0.0),
     velocity_south_(0.0),
     velocity_east_(0.0),
     velocity_west_(0.0),
     previous_velocity_(0.0),
     previous_velocity_north_(0.0),
     previous_velocity_south_(0.0),
     previous_velocity_east_(0.0),
     previous_velocity_west_(0.0),
     vc_(0.0),
     yj_(0.0),
     yc_(0.0),
     neighbor_north_(NULL),
     neighbor_south_(NULL),
     neighbor_east_(NULL),
     neighbor_west_(NULL)
 {
     yj_ = 2.0 * ( (delta * delta) / (tau * tau * gamma * gamma) );
     yc_ = 2.0 * ( (delta * delta) / (tau * tau * gamma * gamma) - 2.0);
 
     // Ensure the leak gain is negative.
     if(leak_gain_ > 0.0)
     {
         leak_gain_ *= -1.0;
     }
 
 //~    cout << "T = " << t << endl
 //~         << "delta = " << delta << endl
 //~         << "gamma = " << gamma << endl
 //~         << "yj = " << yj_ << endl
 //~         << "yc = " << yc_ << endl;
 }

MeshJunction::MeshJunction ( const MeshJunction & copy )

This operator can not assign neighbor pointers.

Definition at line 84 of file MeshJunction.cc.

     :
     leak_gain_(0.0),
     velocity_(0.0),
     velocity_north_(0.0),
     velocity_south_(0.0),
     velocity_east_(0.0),
     velocity_west_(0.0),
     previous_velocity_(0.0),
     previous_velocity_north_(0.0),
     previous_velocity_south_(0.0),
     previous_velocity_east_(0.0),
     previous_velocity_west_(0.0),
     vc_(0.0),
     yj_(0.0),
     yc_(0.0),
     neighbor_north_(NULL),
     neighbor_south_(NULL),
     neighbor_east_(NULL),
     neighbor_west_(NULL)
 {
     *this = copy;
     // This operator can not assign neighbor pointers.
 }

MeshJunction::~MeshJunction ( )

Deconstructor.

Definition at line 111 of file MeshJunction.cc.

112 {

113 }

Member Function Documentation

void MeshJunction::clear ( )

Clears all velicityes in the junctino.

Definition at line 117 of file MeshJunction.cc.

References previous_velocity_, previous_velocity_east_, previous_velocity_north_, previous_velocity_south_, previous_velocity_west_, velocity_, velocity_east_, velocity_north_, velocity_south_, and velocity_west_.

Referenced by Nsound::Mesh2D::clear().

 {
     velocity_                =
     velocity_north_          =
     velocity_south_          =
     velocity_east_           =
     velocity_west_           =
     previous_velocity_       =
     previous_velocity_north_ =
     previous_velocity_south_ =
     previous_velocity_east_  =
     previous_velocity_west_  = 0.0;
 }

float64 MeshJunction::getVelocity ( ) const

Definition at line 133 of file MeshJunction.cc.

References velocity_.

Referenced by Nsound::Mesh2D::getEnergy(), Nsound::Mesh2D::strike(), and Nsound::Mesh2D::tick().

 {
     return velocity_;
 }

MeshJunction & MeshJunction::operator= ( const MeshJunction & rhs )

This operator can not assign neighbor pointers.

Definition at line 141 of file MeshJunction.cc.

References leak_gain_, previous_velocity_, previous_velocity_east_, previous_velocity_north_, previous_velocity_south_, previous_velocity_west_, vc_, velocity_, velocity_east_, velocity_north_, velocity_south_, velocity_west_, yc_, and yj_.

 {
     if(this == & rhs)
     {
         return *this;
     }
 
     leak_gain_ = rhs.leak_gain_;
 
     velocity_ = rhs.velocity_;
 
     velocity_north_ = rhs.velocity_north_;
     velocity_south_ = rhs.velocity_south_;
     velocity_east_  = rhs.velocity_east_;
     velocity_west_  = rhs.velocity_west_;
 
     previous_velocity_       = rhs.previous_velocity_;
     previous_velocity_north_ = rhs.previous_velocity_north_;
     previous_velocity_south_ = rhs.previous_velocity_south_;
     previous_velocity_east_  = rhs.previous_velocity_east_;
     previous_velocity_west_  = rhs.previous_velocity_west_;
 
     vc_ = rhs.vc_;
     yj_ = rhs.yj_;
     yc_ = rhs.yc_;
 
     // This operator can not assign neighbor pointers.
 
     return *this;
 }

void MeshJunction::setNeighborNorth ( MeshJunction * ptr )

Definition at line 174 of file MeshJunction.cc.

References neighbor_north_.

Referenced by Nsound::Mesh2D::allocMemory().

 {
     neighbor_north_ = ptr;
 }

void MeshJunction::setNeighborSouth ( MeshJunction * ptr )

Definition at line 181 of file MeshJunction.cc.

References neighbor_south_.

Referenced by Nsound::Mesh2D::allocMemory().

 {
     neighbor_south_ = ptr;
 }

void MeshJunction::setNeighborEast ( MeshJunction * ptr )

Definition at line 188 of file MeshJunction.cc.

References neighbor_east_.

Referenced by Nsound::Mesh2D::allocMemory().

 {
     neighbor_east_ = ptr;
 }

void MeshJunction::setNeighborWest ( MeshJunction * ptr )

Definition at line 195 of file MeshJunction.cc.

References neighbor_west_.

Referenced by Nsound::Mesh2D::allocMemory().

 {
     neighbor_west_ = ptr;
 }

void MeshJunction::saveState ( )

Saves previous south and east velocities.

Definition at line 214 of file MeshJunction.cc.

References previous_velocity_, previous_velocity_east_, previous_velocity_north_, previous_velocity_south_, previous_velocity_west_, velocity_, velocity_east_, velocity_north_, velocity_south_, and velocity_west_.

Referenced by Nsound::Mesh2D::tick().

 {
     previous_velocity_       = velocity_;
     previous_velocity_north_ = velocity_north_;
     previous_velocity_south_ = velocity_south_;
     previous_velocity_east_  = velocity_east_;
     previous_velocity_west_  = velocity_west_;
 }

void MeshJunction::strike ( const float64 & velocity )

Adds velocity to this junction.

Definition at line 202 of file MeshJunction.cc.

References velocity_, velocity_east_, velocity_north_, velocity_south_, velocity_west_, and yj_.

Referenced by Nsound::Mesh2D::tick().

 {
     velocity_ += velocity;
 
     velocity_north_ += yj_ / 8.0 * velocity;
     velocity_south_ += yj_ / 8.0 * velocity;
     velocity_east_  += yj_ / 8.0 * velocity;
     velocity_west_  += yj_ / 8.0 * velocity;
 }

void MeshJunction::updateVelocity ( )

updates junction velocity.

Definition at line 225 of file MeshJunction.cc.

References neighbor_east_, neighbor_north_, neighbor_south_, neighbor_west_, previous_velocity_east_, previous_velocity_north_, previous_velocity_south_, previous_velocity_west_, updateBoundry(), vc_, velocity_, velocity_east_, velocity_north_, velocity_south_, velocity_west_, yc_, and yj_.

Referenced by Nsound::Mesh2D::tick().

 {
     velocity_ = 2.0 / yj_ * (  previous_velocity_north_
                              + previous_velocity_south_
                              + previous_velocity_east_
                              + previous_velocity_west_
                              + yc_ * vc_);
 
     if(neighbor_north_)
     {
         neighbor_north_->velocity_south_ = velocity_ - previous_velocity_north_;
     }
 
     if(neighbor_south_)
     {
         neighbor_south_->velocity_north_ = velocity_ - previous_velocity_south_;
     }
 
     if(neighbor_west_)
     {
         neighbor_west_->velocity_east_ = velocity_ - previous_velocity_west_;
     }
 
     if(neighbor_east_)
     {
         neighbor_east_->velocity_west_ = velocity_ - previous_velocity_east_;
     }
 
     vc_ = velocity_ - vc_;
 
     updateBoundry();
 
 }

void MeshJunction::updateBoundry ( )

private

Definition at line 262 of file MeshJunction.cc.

References leak_gain_, neighbor_east_, neighbor_north_, neighbor_south_, neighbor_west_, velocity_east_, velocity_north_, velocity_south_, and velocity_west_.

Referenced by updateVelocity().

 {
     if(neighbor_north_ == NULL)
     {
         float64 vtemp = velocity_north_;
 
         velocity_north_ = leak_gain_ * velocity_south_;
 
         if(neighbor_south_)
         {
             neighbor_south_->velocity_north_ = vtemp;
         }
 
     }
 
     if(neighbor_south_ == NULL)
     {
         float64 vtemp = velocity_south_;
 
         velocity_south_ = leak_gain_ * velocity_north_;
 
         if(neighbor_north_)
         {
             neighbor_north_->velocity_south_ = vtemp;
         }
 
     }
 
     if(neighbor_east_ == NULL)
     {
         float64 vtemp = velocity_east_;
 
         velocity_east_ = leak_gain_ * velocity_west_;
 
         if(neighbor_west_)
         {
             neighbor_west_->velocity_east_ = vtemp;
         }
 
     }
 
     if(neighbor_west_ == NULL)
     {
         float64 vtemp = velocity_west_;
 
         velocity_west_ = leak_gain_ * velocity_east_;
 
         if(neighbor_east_)
         {
             neighbor_east_->velocity_west_ = vtemp;
         }
 
     }
 }