Surface Class Reference

#include <Surface.h>

Inheritance diagram for Surface:

Collaboration diagram for Surface:

List of all members.

Public Member Functions
	Surface ()
virtual	~Surface ()
	Surface (float z, float rms_lo, float rms_hi, float xmin, float xmax, float ymin, float ymax, StructureObject *el)
virtual double	mZposition (WavePacket &wp) const
virtual int	Process (WavePacket &wp, int up_down, int internal) const
virtual int	mIntercept (WavePacket &wp, double t1in, double t2in, int ud, double &t) const
virtual int	mGetTypeSurface () const
virtual double	mGetSurfPosition () const
virtual double	mGetZmin () const
virtual double	mGetZmax () const
virtual double	mGetXmin () const
virtual double	mGetXmax () const
virtual double	mGetYmin () const
virtual double	mGetYmax () const
virtual double	mGetZoffset () const
Protected Attributes
float	mZoffset
float	mZmin
float	mZmax
V2< float >	rms
int	mTypeSurface
Friends
class	SimVolume
class	SurfaceTopo
class	SurfaceTopography
class	SurfaceTN
class	SurfaceTNSubflat
class	SurfaceTNInk

---

Constructor & Destructor Documentation

Surface::Surface

(

)

Surface::~Surface

(

)

[virtual]

Surface::Surface	(	float	z,
		float	rms_lo,
		float	rms_hi,
		float	xmin,
		float	xmax,
		float	ymin,
		float	ymax,
		StructureObject *	el
	)

Constructor

Parameters:

z	Distance to plane surface
rms_lo	Root mean suare roughness of the paper over the small area
rms_hi	Root mean suare roughness of the paper over small area
xmin	Minimum Size of the simulation volume in the x-coordinate
xmax	Maximum Size of the simulation volume in the x-coordinate
ymin	Minimum Size of the simulation volume in the y-coordinate
el	Instance of StructureObject class is used to appraoch next surface layer untill last one

Here is the call graph for this function:

---

Member Function Documentation

virtual double Surface::mGetSurfPosition

(

)

const [inline, virtual]

Here is the caller graph for this function:

virtual int Surface::mGetTypeSurface

(

)

const [inline, virtual]

virtual double Surface::mGetXmax

(

)

const [inline, virtual]

virtual double Surface::mGetXmin

(

)

const [inline, virtual]

virtual double Surface::mGetYmax

(

)

const [inline, virtual]

virtual double Surface::mGetYmin

(

)

const [inline, virtual]

virtual double Surface::mGetZmax

(

)

const [inline, virtual]

virtual double Surface::mGetZmin

(

)

const [inline, virtual]

virtual double Surface::mGetZoffset

(

)

const [inline, virtual]

Here is the caller graph for this function:

int Surface::mIntercept	(	WavePacket &	wp,
		double	t1in,
		double	t2in,
		int	ud,
		double &	t
	)		const [virtual]

Save surface normal and position for next SURFSCAT if wp hit the surface

Parameters:

wp	Wave Packet's object to calculate ditance of plane surface
t1in	Smaller distance of propagation
t2in	Smaller distance of propagation
ud
t	Determines the propagation distance

Reimplemented in SurfaceTNSubflat, SurfaceTN, and SurfaceTopography.

Here is the call graph for this function:

Here is the caller graph for this function:

virtual double Surface::mZposition

(

WavePacket &

wp

)

const [inline, virtual]

Parameters:

wp	Instance of wave packet class

Reimplemented in SurfaceTNSubflat, SurfaceTN, and SurfaceTopography.

Here is the caller graph for this function:

int Surface::Process	(	WavePacket &	wp,
		int	up_down,
		int	internal
	)		const [virtual]

Check if two surfaces are same level,no Homogenouse layer exist

Parameters:

wp	Wave Packet's object to calculate ditance of interception and call many fuctions of wave packet.
up_down	Checks if wave packet is travelling in upward.

Implements StructureObject.

Reimplemented in SurfaceTN, SurfaceTopography, and SurfaceTNInk.

Here is the call graph for this function:

---

Friends And Related Function Documentation

friend class SimVolume [friend]

friend class SurfaceTN [friend]

friend class SurfaceTNInk [friend]

friend class SurfaceTNSubflat [friend]

friend class SurfaceTopo [friend]

friend class SurfaceTopography [friend]

---

Member Data Documentation

int Surface::mTypeSurface [protected]

float Surface::mZmax [protected]

float Surface::mZmin [protected]

float Surface::mZoffset [protected]

Parameters:

mXmin	Minimum size of the simulation volume in the x-coordinate direction
mXmax	Maximum size of the simulation volume in the x-coordinate direction
mYmin	Minimum size of the simulation volume in the y-coordinate direction.
mYMax	Maximum Size of the simulation volume in the y-coordinate direction
mZoffset
mZmin	Minimum size of the simulation volume in the z-coordinate direction.
mZmax	Maximum Size of the simulation volume in the z-coordinate direction

V2<float> Surface::rms [protected]

---

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

• OpenPaperOpt/Surface.h
• OpenPaperOpt/Surface.cpp