Internal declarations for the VCSnonideal package

More...

#include <cstring>
#include "cantera/equil/vcs_defs.h"
#include "cantera/base/global.h"

Include dependency graph for vcs_internal.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	VCS_COUNTERS
	Amount of extra printing that is done while in debug mode. More...

Macros
#define	ALTLINPROG

#define	VCS_DATA_PTR(vvv) (&(vvv[0]))
	Points to the data in a std::vector<> object.

#define	plogf Cantera::writelogf
	define this Cantera function to replace printf

#define	plogendl() Cantera::writelogendl()
	define this Cantera function to replace cout << endl;

#define	USE_MEMSET
	This define turns on using memset and memcpy.

Typedefs
typedef double(*	VCS_FUNC_PTR )(double xval, double Vtarget, int varID, void fptrPassthrough, int err)
	Definition of the function pointer for the root finder.

Functions
double	vcsUtil_gasConstant (int mu_units)
	Returns the value of the gas constant in the units specified by parameter.

int	vcsUtil_mlequ (double c, size_t idem, size_t n, double b, size_t m)
	Invert an n x n matrix and solve m rhs's.

int	vcsUtil_gaussj (double c, size_t idem, size_t n, double b, size_t m)
	Invert an n x n matrix and solve m rhs's.

int	vcsUtil_root1d (double xmin, double xmax, size_t itmax, VCS_FUNC_PTR func, void fptrPassthrough, double FuncTargVal, int varID, double xbest, int printLvl=0)
	One dimensional root finder.

double	vcs_second ()
	Returns the system wall clock time in seconds.

void	vcs_dzero (double *const vec_to, const size_t length)
	Zero a double vector.

void	vcs_izero (int *const vec_to, const size_t length)
	Zero an int vector.

void	vcs_dcopy (double const vec_to, const double const vec_from, const size_t length)
	Copy a double vector.

void	vcs_icopy (int const vec_to, const int const vec_from, const size_t length)
	Copy an int vector.

void	vcs_vdzero (std::vector< double > &vec_to, const size_t length)
	Zero a std double vector.

void	vcs_vizero (std::vector< int > &vec_to, const size_t length)
	Zero a std int vector.

void	vcs_vdcopy (std::vector< double > &vec_to, const std::vector< double > &vec_from, size_t length)
	Copy one std double vector into another.

void	vcs_vicopy (std::vector< int > &vec_to, const std::vector< int > &vec_from, const int length)
	Copy one std integer vector into another.

double	vcs_l2norm (const std::vector< double > vec)
	determine the l2 norm of a vector of doubles

size_t	vcs_optMax (const double x, const double xSize, size_t j, size_t n)
	Finds the location of the maximum component in a double vector.

int	vcs_max_int (const int *vector, int length)
	Returns the maximum integer in a list.

void	vcs_print_line (const char *str, int num)
	Prints a line consisting of multiple occurrences of the same string.

const char *	vcs_speciesType_string (int speciesStatus, int length=100)
	Returns a const char string representing the type of the species given by the first argument.

void	vcs_print_stringTrunc (const char *str, size_t space, int alignment)
	Print a string within a given space limit.

bool	vcs_doubleEqual (double d1, double d2)
	Simple routine to check whether two doubles are equal up to roundoff error.

Detailed Description

Internal declarations for the VCSnonideal package

Definition in file vcs_internal.h.

Macro Definition Documentation

#define VCS_DATA_PTR ( vvv ) (&(vvv[0]))

Points to the data in a std::vector<> object.

Definition at line 29 of file vcs_internal.h.

Referenced by vcs_VolPhase::_updateActCoeff(), vcs_VolPhase::_updateG0(), vcs_VolPhase::_updateGStar(), vcs_VolPhase::_updateLnActCoeffJac(), vcs_VolPhase::_updateVolPM(), vcs_VolPhase::_updateVolStar(), vcs_MultiPhaseEquil::reportCSV(), VCS_PROB::set_gai(), vcs_VolPhase::setCreationMoleNumbers(), vcs_VolPhase::setMolesFromVCS(), vcs_VolPhase::setPtrThermoPhase(), VCS_SOLVE::vcs_add_all_deleted(), VCS_SOLVE::vcs_basopt(), VCS_SOLVE::vcs_delete_species(), VCS_SOLVE::vcs_deltag(), VCS_SOLVE::vcs_deltag_Phase(), VCS_SOLVE::vcs_dfe(), VCS_SOLVE::vcs_globStepDamp(), VCS_SOLVE::vcs_inest(), VCS_SOLVE::vcs_inest_TP(), VCS_SOLVE::vcs_phaseStabilityTest(), VCS_SOLVE::vcs_prep(), VCS_SOLVE::vcs_prep_oneTime(), VCS_SOLVE::vcs_printSpeciesChemPot(), VCS_SOLVE::vcs_prob_specifyFully(), VCS_SOLVE::vcs_prob_update(), VCS_SOLVE::vcs_recheck_deleted(), VCS_SOLVE::vcs_report(), VCS_SOLVE::vcs_RxnStepSizes(), VCS_SOLVE::vcs_solve_TP(), and VCS_SOLVE::vcs_updateVP().

#define plogf Cantera::writelogf

define this Cantera function to replace printf

We can replace this with printf easily

Definition at line 35 of file vcs_internal.h.

#define plogendl ( ) Cantera::writelogendl()

define this Cantera function to replace cout << endl;

We use this to place an endl in the log file, and ensure that the IO buffers are flushed.

Definition at line 42 of file vcs_internal.h.

Referenced by VCS_SOLVE::delta_species(), vcs_MultiPhaseEquil::equilibrate_HP(), vcs_VolPhase::setExistence(), VCS_SOLVE::vcs_add_all_deleted(), VCS_SOLVE::vcs_basopt(), VCS_SOLVE::vcs_delete_species(), VCS_SOLVE::vcs_deltag_Phase(), VCS_SOLVE::vcs_dfe(), VCS_SOLVE::vcs_elem_rearrange(), VCS_SOLVE::vcs_globStepDamp(), VCS_SOLVE::vcs_inest(), VCS_SOLVE::vcs_inest_TP(), VCS_SOLVE::vcs_nondim_Farad(), VCS_SOLVE::vcs_nondim_TP(), VCS_SOLVE::vcs_nondimMult_TP(), VCS_SOLVE::vcs_redim_TP(), VCS_SOLVE::vcs_RxnStepSizes(), VCS_SOLVE::vcs_solve_TP(), VCS_SOLVE::vcs_switch_elem_pos(), VCS_SOLVE::vcs_updateVP(), and VCS_SOLVE::vcs_zero_species().

#define USE_MEMSET

This define turns on using memset and memcpy.

I have not run into any systems where this is a problem. It's the fastest way to do low lvl operations where applicable. There are alternative routines available if this ever fails.

Definition at line 331 of file vcs_internal.h.

Classes

Macros

Typedefs

Functions

Detailed Description

Macro Definition Documentation