vcs_internal.h File Reference

Internal declarations for the VCSnonideal package. More...

#include <cstring>
#include "vcs_defs.h"
#include <vector>
#include <string>
#include "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...

Defines

#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, int idem, int n, double *b, int m)
 Invert an n x n matrix and solve m rhs's.
void vcsUtil_dsw (double x[], int i1, int i2)
 Swap values in vector of doubles.
void vcsUtil_isw (int x[], int i1, int i2)
 Swap values in an integer array.
void vcsUtil_stsw (std::vector< std::string > &vecStrings, int i1, int i2)
 Swap values in a std vector string.
int vcsUtil_root1d (double xmin, double xmax, int 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 int length)
 Zero a double vector.
void vcs_izero (int *const vec_to, const int length)
 Zero an int vector.
void vcs_dcopy (double *const vec_to, const double *const vec_from, const int length)
 Copy a double vector.
void vcs_icopy (int *const vec_to, const int *const vec_from, const int length)
 Copy an int vector.
void vcs_vdzero (std::vector< double > &vec_to, const int length)
 Zero a std double vector.
void vcs_vizero (std::vector< int > &vec_to, const int length)
 Zero a std int vector.
void vcs_vdcopy (std::vector< double > &vec_to, const std::vector< double > &vec_from, int 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
int vcs_optMax (const double *x, const double *xSize, int j, int 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 mutliple occurances 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, int 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.

Variables

int vcs_timing_print_lvl
 Global hook for turning on and off time printing.

Detailed Description

Internal declarations for the VCSnonideal package.

Definition in file vcs_internal.h.


Define Documentation

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

Referenced by vcs_MultiPhaseEquil::equilibrate_HP().

#define plogf   Cantera::writelogf
#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 324 of file vcs_internal.h.

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

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

Definition at line 26 of file vcs_internal.h.

Referenced by vcs_MultiPhaseEquil::reportCSV().

Generated by  doxygen 1.6.3