vcs_internal.h File Reference

Internal declarations for the VCSnonideal package. More...

#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
	Class to keep track of time and iterations. More...

Namespaces
	Cantera
	Namespace for the Cantera kernel.

Macros
#define	plogf   writelogf
	define this Cantera function to replace printf More...
#define	plogendl()   writelogendl()
	define this Cantera function to replace cout << endl; More...

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. More...

Functions
double	vcs_l2norm (const vector_fp &vec)
	determine the l2 norm of a vector of doubles More...
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. More...
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. More...
bool	vcs_doubleEqual (double d1, double d2)
	Simple routine to check whether two doubles are equal up to roundoff error. More...

Detailed Description

Internal declarations for the VCSnonideal package.

Definition in file vcs_internal.h.

Macro Definition Documentation

plogf

#define plogf   writelogf

define this Cantera function to replace printf

We can replace this with printf easily

Definition at line 18 of file vcs_internal.h.

Referenced by vcs_MultiPhaseEquil::determine_PhaseStability(), vcs_MultiPhaseEquil::equilibrate_HP(), vcs_MultiPhaseEquil::equilibrate_SP(), vcs_MultiPhaseEquil::equilibrate_TP(), VCS_SOLVE::prneav(), VCS_PROB::prob_report(), vcs_VolPhase::setPtrThermoPhase(), VCS_SOLVE::vcs(), VCS_SOLVE::vcs_add_all_deleted(), VCS_SOLVE::vcs_basopt(), Cantera::vcs_Cantera_update_vprob(), VCS_SOLVE::vcs_delete_multiphase(), VCS_SOLVE::vcs_deltag(), VCS_SOLVE::vcs_deltag_Phase(), VCS_SOLVE::vcs_dfe(), VCS_SOLVE::vcs_elcorr(), VCS_SOLVE::vcs_elem_rearrange(), VCS_SOLVE::vcs_evaluate_speciesType(), VCS_SOLVE::vcs_globStepDamp(), VCS_SOLVE::vcs_inest(), VCS_SOLVE::vcs_inest_TP(), VCS_SOLVE::vcs_initSizes(), vcs_MultiPhaseEquil::vcs_MultiPhaseEquil(), VCS_SOLVE::vcs_phaseStabilityTest(), VCS_SOLVE::vcs_popPhaseID(), VCS_SOLVE::vcs_popPhaseRxnStepSizes(), VCS_SOLVE::vcs_prob_specify(), VCS_SOLVE::vcs_prob_specifyFully(), VCS_SOLVE::vcs_PS(), VCS_SOLVE::vcs_recheck_deleted(), VCS_SOLVE::vcs_redim_TP(), VCS_SOLVE::vcs_reinsert_deleted(), VCS_SOLVE::vcs_report(), VCS_SOLVE::vcs_rxn_adj_cg(), VCS_SOLVE::vcs_RxnStepSizes(), VCS_SOLVE::vcs_setMolesLinProg(), VCS_SOLVE::vcs_solve_TP(), VCS_SOLVE::vcs_species_type(), VCS_SOLVE::vcs_switch_pos(), VCS_SOLVE::vcs_TCounters_report(), VCS_SOLVE::vcs_TP(), and VCS_SOLVE::vcs_zero_species().

plogendl

#define plogendl

(

)

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 25 of file vcs_internal.h.

Referenced by vcs_MultiPhaseEquil::equilibrate_HP(), VCS_SOLVE::prneav(), VCS_SOLVE::vcs_basopt(), VCS_SOLVE::vcs_dfe(), VCS_SOLVE::vcs_elem_rearrange(), VCS_SOLVE::vcs_evaluate_speciesType(), VCS_SOLVE::vcs_inest(), VCS_SOLVE::vcs_inest_TP(), VCS_SOLVE::vcs_redim_TP(), VCS_SOLVE::vcs_RxnStepSizes(), and VCS_SOLVE::vcs_zero_species().