US_ZSolute Class Reference

Solutes for UltraScan (XYZ form) More...

#include "us_zsolute.h"

Public Types
enum	attr_type {   ATTR_S, ATTR_K, ATTR_W, ATTR_V,   ATTR_D, ATTR_C =9 }
	The types of attributes that map to XYZ. More...

Public Member Functions
	US_ZSolute (double=0.0, double=0.0, double=0.0, double=0.0)
bool	operator== (const US_ZSolute &solute)
bool	operator!= (const US_ZSolute &solute)
bool	operator< (const US_ZSolute &solute) const

Static Public Member Functions
static void	put_mcomp_attr (US_Model::SimulationComponent &, double &, const int)
static void	put_solute_attr (US_ZSolute &, double &, const int)
static void	get_mcomp_attr (US_Model::SimulationComponent &, double &, const int)
static void	get_solute_attr (US_ZSolute &, double &, const int)
static void	set_mcomp_values (US_Model::SimulationComponent &, US_ZSolute &, const int, const bool=false)
static void	set_solute_values (US_Model::SimulationComponent &, US_ZSolute &, const int)
static void	init_grid_solutes (double, double, int, double, double, int, int, double *, QList< QVector< US_ZSolute > > &)

Public Attributes
double	x
	X value. More...
double	y
	Y value. More...
double	z
	Z value. More...
double	c
	Concentration. More...

Static Private Member Functions
static int	zcoeff_flag (double *)
static QVector< US_ZSolute >	create_grid_solutes (double, double, double, double, double, double, double *)

Detailed Description

Solutes for UltraScan (XYZ form)

This class provides a solute structure and utilities

Definition at line 14 of file us_zsolute.h.

Member Enumeration Documentation

enum US_ZSolute::attr_type

The types of attributes that map to XYZ.

Enumerator
ATTR_S
ATTR_K
ATTR_W
ATTR_V
ATTR_D
ATTR_C

Definition at line 64 of file us_zsolute.h.

Constructor & Destructor Documentation

US_ZSolute::US_ZSolute	(	double	x0 = 0.0,
		double	y0 = 0.0,
		double	z0 = 0.0,
		double	c0 = 0.0
	)

Parameters

x0	The initial X (e.g.,sedimentation)
y0	The initial Y (e.g., frictional ratio)
z0	The initial Z (e.g., vbar20)
c0	The initial concentration

Definition at line 6 of file us_zsolute.cpp.

Member Function Documentation

QVector< US_ZSolute > US_ZSolute::create_grid_solutes ( double  x_min, double  x_max, double  x_step, double  y_min, double  y_max, double  y_step, double *  z_coeffs  )

staticprivate

Definition at line 209 of file us_zsolute.cpp.

void US_ZSolute::get_mcomp_attr ( US_Model::SimulationComponent &  comp, double &  aval, const int  a_type  )

static

A static function to get a model component attribute value

Parameters

comp	Model component from which to get value
aval	Attribute value fetched
a_type	Attribute type to get (ATTR_S,...,ATTR_D).

Definition at line 65 of file us_zsolute.cpp.

void US_ZSolute::get_solute_attr ( US_ZSolute &  solute, double &  aval, const int  a_type  )

static

A static function to get a solute attribute value

Parameters

solute	Solute from which to get value
aval	Attribute value fetched
a_type	Attribute type to get (0,1,2 -> X,Y,Z).

Definition at line 93 of file us_zsolute.cpp.

void US_ZSolute::init_grid_solutes ( double  x_min, double  x_max, int  x_res, double  y_min, double  y_max, int  y_res, int  grid_reps, double *  z_coeffs, QList< QVector< US_ZSolute > > &  solutes  )

static

A static function to initialize grid solutes

Parameters

x_min	The minimum X value
x_max	The maximum X value
x_res	The number of points to evaluate between x_min and x_max
y_min	The minimum Y value
y_max	The maximum Y value
y_res	The number of points to evaluate between y_min and y_max
grid_reps	The number of grids used to partition the data
z_coeffs	Z coefficients for compute-Z function
solutes	A reference to the output values. This is a list of vectors.

Definition at line 163 of file us_zsolute.cpp.

bool US_ZSolute::operator!= ( const US_ZSolute &  solute )

inline

A test for inequality.

Parameters

solute

A value for comparison

Definition at line 39 of file us_zsolute.h.

bool US_ZSolute::operator< ( const US_ZSolute &  solute ) const

inline

A test for ordering solutes. Tests in x,y,z order.

Parameters

solute

A value for comparison

Definition at line 47 of file us_zsolute.h.

bool US_ZSolute::operator== ( const US_ZSolute &  solute )

inline

A test for solute equality

Parameters

solute

A value for comparison

Definition at line 31 of file us_zsolute.h.

void US_ZSolute::put_mcomp_attr ( US_Model::SimulationComponent &  comp, double &  aval, const int  a_type  )

static

A static function to put a model component attribute value

Parameters

comp	Model component in which to put value
aval	Attribute value to put
a_type	Attribute type to put (ATTR_S,...,ATTR_D).

Definition at line 15 of file us_zsolute.cpp.

void US_ZSolute::put_solute_attr ( US_ZSolute &  solute, double &  aval, const int  a_type  )

static

A static function to put a solute attribute value

Parameters

solute	Solute in which to put value
aval	Attribute value to put
a_type	Attribute type to put (0,1,2 -> X,Y,Z).

Definition at line 43 of file us_zsolute.cpp.

void US_ZSolute::set_mcomp_values ( US_Model::SimulationComponent &  comp, US_ZSolute &  solute, const int  s_type, const bool  concv = false  )

static

A static function to set model component attribute values

Parameters

comp	Model component in which to set values
solute	Solute from which to set values
s_type	Solute type mask
concv	Flag to copy concentration value, too

Definition at line 115 of file us_zsolute.cpp.

void US_ZSolute::set_solute_values ( US_Model::SimulationComponent &  comp, US_ZSolute &  solute, const int  s_type  )

static

A static function to set solute attribute values

Parameters

comp	Model component from which to set values
solute	Solute to which to set values
s_type	Solute type mask

Definition at line 141 of file us_zsolute.cpp.

int US_ZSolute::zcoeff_flag ( double *  zcoeffs )

staticprivate

Definition at line 199 of file us_zsolute.cpp.

Member Data Documentation

double US_ZSolute::c

Concentration.

Definition at line 27 of file us_zsolute.h.

double US_ZSolute::x

X value.

Definition at line 24 of file us_zsolute.h.

double US_ZSolute::y

Y value.

Definition at line 25 of file us_zsolute.h.

double US_ZSolute::z

Z value.

Definition at line 26 of file us_zsolute.h.

---

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

• us_zsolute.h
• us_zsolute.cpp