iphreeqc/Surface.cxx
David L Parkhurst 4230069264 fixed warn again.
fixed error when no doubles sent in message.

git-svn-id: svn://136.177.114.72/svn_GW/phreeqcpp/trunk@1422 1feff8c3-07ed-0310-ac33-dd36852eb9cd
2006-11-01 16:00:47 +00:00

635 lines
25 KiB
C++

// Surface.cxx: implementation of the cxxSurface class.
//
//////////////////////////////////////////////////////////////////////
#ifdef _DEBUG
#pragma warning(disable : 4786) // disable truncation warning (Only used by debugger)
#endif
#include "Utils.h" // define first
#include "Surface.h"
#include "SurfaceComp.h"
#define EXTERNAL extern
#include "global.h"
#include "phqalloc.h"
#include "phrqproto.h"
#include <cassert> // assert
#include <algorithm> // std::sort
//////////////////////////////////////////////////////////////////////
// Construction/Destruction
//////////////////////////////////////////////////////////////////////
cxxSurface::cxxSurface()
//
// default constructor for cxxSurface
//
: cxxNumKeyword()
{
type = NO_EDL;
dl_type = NO_DL;
sites_units = SITES_ABSOLUTE;
//diffuse_layer = false;
//edl = false;
only_counter_ions = false;
//donnan = false;
thickness = 0.0;
debye_lengths = 0.0;
DDL_viscosity = 0.0;
DDL_limit = 0.0;
transport = false;
}
cxxSurface::cxxSurface(struct surface *surface_ptr)
//
// constructor for cxxSurface from struct surface
//
:
cxxNumKeyword()
{
int i;
this->set_description(surface_ptr->description);
n_user = surface_ptr->n_user;
n_user_end = surface_ptr->n_user_end;
type = surface_ptr->type;
dl_type = surface_ptr->dl_type;
sites_units = surface_ptr->sites_units;
//diffuse_layer = (surface_ptr->diffuse_layer == TRUE);
//edl = (surface_ptr->edl == TRUE);
only_counter_ions = (surface_ptr->only_counter_ions == TRUE);
//donnan = (surface_ptr->donnan == TRUE);
thickness = surface_ptr->thickness;
debye_lengths = surface_ptr->debye_lengths;
DDL_viscosity = surface_ptr->DDL_viscosity;
DDL_limit = surface_ptr->DDL_limit;
transport = (surface_ptr->transport == TRUE);
// Surface components
for (i = 0; i < surface_ptr->count_comps; i++) {
cxxSurfaceComp ec(&(surface_ptr->comps[i]));
surfaceComps.push_back(ec);
}
// Surface charge
for (i = 0; i < surface_ptr->count_charge; i++) {
cxxSurfaceCharge ec(&(surface_ptr->charge[i]));
surfaceCharges.push_back(ec);
}
}
cxxSurface::~cxxSurface()
{
}
bool cxxSurface::get_related_phases()
{
for (std::list<cxxSurfaceComp>::const_iterator it = this->surfaceComps.begin(); it != this->surfaceComps.end(); ++it) {
if (it->get_phase_name() == NULL) continue;
return(true);
}
return(false);
}
bool cxxSurface::get_related_rate()
{
for (std::list<cxxSurfaceComp>::const_iterator it = this->surfaceComps.begin(); it != this->surfaceComps.end(); ++it) {
if (it->get_rate_name() == NULL) continue;
return(true);
}
return(false);
}
struct surface *cxxSurface::cxxSurface2surface()
//
// Builds a surface structure from instance of cxxSurface
//
{
struct surface *surface_ptr = surface_alloc();
surface_ptr->description = this->get_description();
surface_ptr->n_user = this->n_user;
surface_ptr->n_user_end = this->n_user_end;
surface_ptr->new_def = FALSE;
surface_ptr->type = this->type;
surface_ptr->dl_type = this->dl_type;
surface_ptr->sites_units = this->sites_units;
//surface_ptr->diffuse_layer = this->diffuse_layer;
//surface_ptr->edl = this->edl;
surface_ptr->only_counter_ions = this->only_counter_ions;
//surface_ptr->donnan = this->donnan;
surface_ptr->thickness = this->thickness;
surface_ptr->debye_lengths = 1.0;
surface_ptr->solution_equilibria = FALSE;
surface_ptr->n_solution = -2;
surface_ptr->related_phases = (int) this->get_related_phases();
surface_ptr->related_rate = (int) this->get_related_rate();
surface_ptr->transport = this->transport;
surface_ptr->debye_lengths = this->debye_lengths;
surface_ptr->DDL_viscosity = this->DDL_viscosity;
surface_ptr->DDL_limit = this->DDL_limit;
// Surface comps
surface_ptr->count_comps = (int) this->surfaceComps.size();
surface_ptr->comps = (struct surface_comp *) free_check_null(surface_ptr->comps);
surface_ptr->comps = cxxSurfaceComp::cxxSurfaceComp2surface_comp(this->surfaceComps);
// Surface charge
surface_ptr->charge = (struct surface_charge *) free_check_null(surface_ptr->charge);
//if (surface_ptr->edl == TRUE) {
if (surface_ptr->type == DDL || surface_ptr->type == CD_MUSIC) {
surface_ptr->count_charge = (int) this->surfaceCharges.size();
surface_ptr->charge = cxxSurfaceCharge::cxxSurfaceCharge2surface_charge(this->surfaceCharges);
} else {
surface_ptr->count_charge = 0;
}
return(surface_ptr);
}
void cxxSurface::dump_xml(std::ostream& s_oss, unsigned int indent)const
{
//const char ERR_MESSAGE[] = "Packing surface message: %s, element not found\n";
unsigned int i;
s_oss.precision(DBL_DIG - 1);
std::string indent0(""), indent1(""), indent2("");
for(i = 0; i < indent; ++i) indent0.append(Utilities::INDENT);
for(i = 0; i < indent + 1; ++i) indent1.append(Utilities::INDENT);
for(i = 0; i < indent + 2; ++i) indent2.append(Utilities::INDENT);
// Surface element and attributes
s_oss << indent0;
s_oss << "<surface " << std::endl;
s_oss << indent1;
//s_oss << "diffuse_layer=\"" << this->diffuse_layer << "\"" << std::endl;
s_oss << "surface_type=\"" << this->type << "\"" << std::endl;
s_oss << indent1;
//s_oss << "edl=\"" << this->edl << "\"" << std::endl;
s_oss << "dl_type=\"" << this->dl_type << "\"" << std::endl;
s_oss << indent1;
s_oss << "sites_units=\"" << this->sites_units << "\"" << std::endl;
s_oss << indent1;
s_oss << "only_counter_ions=\"" << this->only_counter_ions << "\"" << std::endl;
//s_oss << indent1;
//s_oss << "donnan=\"" << this->donnan << "\"" << std::endl;
s_oss << indent1;
s_oss << "thickness=\"" << this->thickness << "\"" << std::endl;
s_oss << indent1;
s_oss << "debye_lengths=\"" << this->debye_lengths << "\"" << std::endl;
s_oss << indent1;
s_oss << "DDL_viscosity=\"" << this->DDL_viscosity << "\"" << std::endl;
s_oss << indent1;
s_oss << "DDL_limit=\"" << this->DDL_limit << "\"" << std::endl;
s_oss << indent1;
s_oss << "transport=\"" << this->transport << "\"" << std::endl;
// surface component structures
s_oss << indent1;
s_oss << "<component " << std::endl;
{
for (std::list<cxxSurfaceComp>::const_iterator it = this->surfaceComps.begin(); it != this->surfaceComps.end(); ++it) {
it->dump_xml(s_oss, indent + 2);
}
}
// surface charge structures
s_oss << indent1;
s_oss << "<charge_component " << std::endl;
for (std::list<cxxSurfaceCharge>::const_iterator it = surfaceCharges.begin(); it != surfaceCharges.end(); ++it) {
it->dump_xml(s_oss, indent + 2);
}
return;
}
void cxxSurface::dump_raw(std::ostream& s_oss, unsigned int indent)const
{
//const char ERR_MESSAGE[] = "Packing surface message: %s, element not found\n";
unsigned int i;
s_oss.precision(DBL_DIG - 1);
std::string indent0(""), indent1(""), indent2("");
for(i = 0; i < indent; ++i) indent0.append(Utilities::INDENT);
for(i = 0; i < indent + 1; ++i) indent1.append(Utilities::INDENT);
for(i = 0; i < indent + 2; ++i) indent2.append(Utilities::INDENT);
// Surface element and attributes
s_oss << indent0;
s_oss << "SURFACE_RAW " << this->n_user << " " << this->description << std::endl;
s_oss << indent1;
//s_oss << "-diffuse_layer " << this->diffuse_layer << std::endl;
s_oss << "-type " << this->type << std::endl;
s_oss << indent1;
//s_oss << "-edl " << this->edl << std::endl;
s_oss << "-dl_type " << this->dl_type << std::endl;
s_oss << indent1;
s_oss << "-sites_units " << this->sites_units << std::endl;
s_oss << indent1;
s_oss << "-only_counter_ions " << this->only_counter_ions << std::endl;
//s_oss << indent1;
//s_oss << "-donnan " << this->donnan << std::endl;
s_oss << indent1;
s_oss << "-thickness " << this->thickness << std::endl;
s_oss << indent1;
s_oss << "-debye_lengths " << this->debye_lengths << std::endl;
s_oss << indent1;
s_oss << "-DDL_viscosity " << this->DDL_viscosity << std::endl;
s_oss << indent1;
s_oss << "-DDL_limit " << this->DDL_limit << std::endl;
s_oss << indent1;
s_oss << "-transport " << this->transport << std::endl;
// surfaceComps structures
for (std::list<cxxSurfaceComp>::const_iterator it = surfaceComps.begin(); it != surfaceComps.end(); ++it) {
s_oss << indent1;
s_oss << "-component" << std::endl;
it->dump_raw(s_oss, indent + 2);
}
// surface charge structures
{
for (std::list<cxxSurfaceCharge>::const_iterator it = surfaceCharges.begin(); it != surfaceCharges.end(); ++it) {
s_oss << indent1;
s_oss << "-charge_component " << std::endl;
it->dump_raw(s_oss, indent + 2);
}
}
return;
}
void cxxSurface::read_raw(CParser& parser)
{
static std::vector<std::string> vopts;
int i = 0;
if (vopts.empty()) {
vopts.reserve(15);
vopts.push_back("diffuse_layer"); // 0
vopts.push_back("edl"); // 1
vopts.push_back("only_counter_ions"); // 2
vopts.push_back("donnan"); // 3
vopts.push_back("thickness"); // 4
vopts.push_back("component"); // 5
vopts.push_back("charge_component"); // 6
vopts.push_back("type "); // 7
vopts.push_back("dl_type"); // 8
vopts.push_back("sites_units"); // 9
vopts.push_back("debye_lengths"); // 10
vopts.push_back("ddl_viscosity"); // 11
vopts.push_back("ddl_limit"); // 12
vopts.push_back("transport"); // 13
}
std::istream::pos_type ptr;
std::istream::pos_type next_char;
std::string token;
int opt_save;
bool useLastLine(false);
// Read surface number and description
this->read_number_description(parser);
opt_save = CParser::OPT_ERROR;
//bool diffuse_layer_defined(false);
//bool edl_defined(false);
bool only_counter_ions_defined(false);
//bool donnan_defined(false);
bool thickness_defined(false);
bool type_defined(false);
bool dl_type_defined(false);
bool sites_units_defined(false);
bool debye_lengths_defined(false);
bool DDL_viscosity_defined(false);
bool DDL_limit_defined(false);
bool transport_defined(false);
for (;;)
{
int opt;
if (useLastLine == false) {
opt = parser.get_option(vopts, next_char);
} else {
opt = parser.getOptionFromLastLine(vopts, next_char);
}
switch (opt)
{
case CParser::OPT_EOF:
break;
case CParser::OPT_KEYWORD:
break;
case CParser::OPT_DEFAULT:
case CParser::OPT_ERROR:
opt = CParser::OPT_EOF;
parser.error_msg("Unknown input in SURFACE keyword.", CParser::OT_CONTINUE);
parser.error_msg(parser.line().c_str(), CParser::OT_CONTINUE);
useLastLine = false;
break;
case 0: // diffuse_layer
parser.incr_input_error();
parser.error_msg("Diffuse layer is obsolete, use -type.", CParser::OT_CONTINUE);
/*
if (!(parser.get_iss() >> this->diffuse_layer))
{
this->diffuse_layer = false;
parser.incr_input_error();
parser.error_msg("Expected boolean value for diffuse_layer.", CParser::OT_CONTINUE);
}
diffuse_layer_defined = true;
*/
useLastLine = false;
break;
case 1: // edl
parser.incr_input_error();
parser.error_msg("-edl is obsolete, use -type.", CParser::OT_CONTINUE);
/*
if (!(parser.get_iss() >> this->edl))
{
this->edl = false;
parser.incr_input_error();
parser.error_msg("Expected boolean value for edl.", CParser::OT_CONTINUE);
}
edl_defined = true;
*/
useLastLine = false;
break;
case 2: // only_counter_ions
if (!(parser.get_iss() >> this->only_counter_ions))
{
this->only_counter_ions = false;
parser.incr_input_error();
parser.error_msg("Expected boolean value for only_counter_ions.", CParser::OT_CONTINUE);
}
only_counter_ions_defined = true;
useLastLine = false;
break;
case 3: // donnan
parser.incr_input_error();
parser.error_msg("-Donnan is obsolete, use -dl_type.", CParser::OT_CONTINUE);
/*
if (!(parser.get_iss() >> this->donnan))
{
this->donnan = false;
parser.incr_input_error();
parser.error_msg("Expected boolean value for donnan.", CParser::OT_CONTINUE);
}
donnan_defined = true;
*/
useLastLine = false;
break;
case 4: // thickness
if (!(parser.get_iss() >> this->thickness))
{
this->thickness = 0.0;
parser.incr_input_error();
parser.error_msg("Expected numeric value for thickness.", CParser::OT_CONTINUE);
}
thickness_defined = true;
useLastLine = false;
break;
case 5: // component
{
cxxSurfaceComp ec;
ec.read_raw(parser);
this->surfaceComps.push_back(ec);
}
useLastLine = true;
break;
case 6: // charge_component
{
cxxSurfaceCharge ec;
ec.read_raw(parser);
this->surfaceCharges.push_back(ec);
}
useLastLine = true;
break;
case 7: // type
i = 0;
if (!(parser.get_iss() >> i))
{
this->type = NO_EDL;
parser.incr_input_error();
parser.error_msg("Expected numeric value for type.", CParser::OT_CONTINUE);
}
this->type = (SURFACE_TYPE) i;
type_defined = true;
useLastLine = false;
break;
case 8: // dl_type
i = 0;
if (!(parser.get_iss() >> i))
{
this->dl_type = NO_DL;
parser.incr_input_error();
parser.error_msg("Expected numeric value for dl_type.", CParser::OT_CONTINUE);
}
this->dl_type = (DIFFUSE_LAYER_TYPE) i;
dl_type_defined = true;
useLastLine = false;
break;
case 9: // sites_units
i = 0;
if (!(parser.get_iss() >> i))
{
this->sites_units = SITES_ABSOLUTE;
parser.incr_input_error();
parser.error_msg("Expected numeric value for sites_units.", CParser::OT_CONTINUE);
}
this->sites_units = (SITES_UNITS) i;
sites_units_defined = true;
useLastLine = false;
break;
case 10: // debye_lengths
if (!(parser.get_iss() >> this->debye_lengths))
{
this->debye_lengths = 0.0;
parser.incr_input_error();
parser.error_msg("Expected numeric value for debye_lengths.", CParser::OT_CONTINUE);
}
debye_lengths_defined = true;
useLastLine = false;
break;
case 11: // DDL_viscosity
if (!(parser.get_iss() >> this->DDL_viscosity))
{
this->DDL_viscosity = 0.0;
parser.incr_input_error();
parser.error_msg("Expected numeric value for DDL_viscosity.", CParser::OT_CONTINUE);
}
DDL_viscosity_defined = true;
useLastLine = false;
break;
case 12: // DDL_limit
if (!(parser.get_iss() >> this->DDL_limit))
{
this->DDL_limit = 0.0;
parser.incr_input_error();
parser.error_msg("Expected numeric value for DDL_limit.", CParser::OT_CONTINUE);
}
DDL_limit_defined = true;
useLastLine = false;
break;
case 13: // transport
if (!(parser.get_iss() >> this->transport))
{
this->transport = false;
parser.incr_input_error();
parser.error_msg("Expected boolean value for transport.", CParser::OT_CONTINUE);
}
transport_defined = true;
useLastLine = false;
break;
}
if (opt == CParser::OPT_EOF || opt == CParser::OPT_KEYWORD) break;
}
// members that must be defined
/*
if (diffuse_layer_defined == false) {
parser.incr_input_error();
parser.error_msg("Diffuse_layer not defined for SURFACE_RAW input.", CParser::OT_CONTINUE);
}
if (edl_defined == false) {
parser.incr_input_error();
parser.error_msg("Edl not defined for SURFACE_RAW input.", CParser::OT_CONTINUE);
}
*/
if (only_counter_ions_defined == false) {
parser.incr_input_error();
parser.error_msg("Only_counter_ions not defined for SURFACE_RAW input.", CParser::OT_CONTINUE);
}
/*
if (donnan_defined == false) {
parser.incr_input_error();
parser.error_msg("Donnan not defined for SURFACE_RAW input.", CParser::OT_CONTINUE);
}
*/
if (thickness_defined == false) {
parser.incr_input_error();
parser.error_msg("Thickness not defined for SURFACE_RAW input.", CParser::OT_CONTINUE);
}
if (type_defined == false) {
parser.incr_input_error();
parser.error_msg("Surface type not defined for SURFACE_RAW input.", CParser::OT_CONTINUE);
}
if (dl_type_defined == false) {
parser.incr_input_error();
parser.error_msg("Dl_type not defined for SURFACE_RAW input.", CParser::OT_CONTINUE);
}
if (sites_units_defined == false) {
parser.incr_input_error();
parser.error_msg("Sites_units not defined for SURFACE_RAW input.", CParser::OT_CONTINUE);
}
if (debye_lengths_defined == false) {
parser.incr_input_error();
parser.error_msg("Debye_lengths not defined for SURFACE_RAW input.", CParser::OT_CONTINUE);
}
if (DDL_viscosity_defined == false) {
parser.incr_input_error();
parser.error_msg("DDL_viscosity not defined for SURFACE_RAW input.", CParser::OT_CONTINUE);
}
if (DDL_limit_defined == false) {
parser.incr_input_error();
parser.error_msg("DDL_limit not defined for SURFACE_RAW input.", CParser::OT_CONTINUE);
}
if (transport_defined == false) {
parser.incr_input_error();
parser.error_msg("Transport not defined for SURFACE_RAW input.", CParser::OT_CONTINUE);
}
}
#ifdef USE_MPI
/* ---------------------------------------------------------------------- */
void cxxSurface::mpi_pack(std::vector<int>& ints, std::vector<double>& doubles)
/* ---------------------------------------------------------------------- */
{
/* int n_user; */
ints.push_back(this->n_user);
ints.push_back((int) this->surfaceComps.size());
for (std::list<cxxSurfaceComp>::iterator it = this->surfaceComps.begin(); it != this->surfaceComps.end(); it++) {
it->mpi_pack(ints, doubles);
}
ints.push_back((int) this->surfaceCharges.size());
for (std::list<cxxSurfaceCharge>::iterator it = this->surfaceCharges.begin(); it != this->surfaceCharges.end(); it++) {
it->mpi_pack(ints, doubles);
}
//ints.push_back((int) this->diffuse_layer);
//ints.push_back((int) this->edl);
ints.push_back((int) this->type);
ints.push_back((int) this->dl_type);
ints.push_back((int) this->sites_units);
ints.push_back((int) this->only_counter_ions);
//ints.push_back((int) this->donnan);
doubles.push_back(this->thickness);
doubles.push_back(this->debye_lengths);
doubles.push_back(this->DDL_viscosity);
doubles.push_back(this->DDL_limit);
ints.push_back((int) this->transport);
}
/* ---------------------------------------------------------------------- */
void cxxSurface::mpi_unpack(int *ints, int *ii, double *doubles, int *dd)
/* ---------------------------------------------------------------------- */
{
int i = *ii;
int d = *dd;
/* int n_user; */
this->n_user = ints[i++];
this->n_user_end = this->n_user;
this->description = " ";
int count = ints[i++];
this->surfaceComps.clear();
for (int n = 0; n < count; n++) {
cxxSurfaceComp sc;
sc.mpi_unpack(ints, &i, doubles, &d);
this->surfaceComps.push_back(sc);
}
count = ints[i++];
this->surfaceCharges.clear();
for (int n = 0; n < count; n++) {
cxxSurfaceCharge sc;
sc.mpi_unpack(ints, &i, doubles, &d);
this->surfaceCharges.push_back(sc);
}
//this->diffuse_layer = (bool) ints[i++];
//this->edl = (bool) ints[i++];
this->type = (SURFACE_TYPE) ints[i++];
this->dl_type = (DIFFUSE_LAYER_TYPE) ints[i++];
this->sites_units = (SITES_UNITS) ints[i++];
this->only_counter_ions = (ints[i++] == TRUE);
//this->donnan = (bool) ints[i++];
this->thickness = doubles[d++];
this->debye_lengths = doubles[d++];
this->DDL_viscosity = doubles[d++];
this->DDL_limit = doubles[d++];
this->transport = (ints[i++] == TRUE);
*ii = i;
*dd = d;
}
#endif