GeochemistryIonicStrength.h

Go to the documentation of this file.

//* This file is part of the MOOSE framework
//* https://mooseframework.inl.gov
//*
//* All rights reserved, see COPYRIGHT for full restrictions
//* https://github.com/idaholab/moose/blob/master/COPYRIGHT
//*
//* Licensed under LGPL 2.1, please see LICENSE for details
//* https://www.gnu.org/licenses/lgpl-2.1.html

#pragma once

#include "PertinentGeochemicalSystem.h"

class GeochemistryIonicStrength
{
public:
  GeochemistryIonicStrength(Real max_ionic_strength,
                            Real max_stoichiometric_ionic_strength,
                            bool use_only_basis_molality,
                            bool use_only_Cl_molality);

  bool operator==(const GeochemistryIonicStrength & rhs) const
  {
    return (_max_ionic_strength == rhs._max_ionic_strength) &&
           (_max_stoichiometric_ionic_strength == rhs._max_stoichiometric_ionic_strength) &&
           (_use_only_basis_molality == rhs._use_only_basis_molality) &&
           (_use_only_Cl_molality == rhs._use_only_Cl_molality);
  };

  Real ionicStrength(const ModelGeochemicalDatabase & mgd,
                     const std::vector<Real> & basis_species_molality,
                     const std::vector<Real> & eqm_species_molality,
                     const std::vector<Real> & kin_species_molality) const;

  Real stoichiometricIonicStrength(const ModelGeochemicalDatabase & mgd,
                                   const std::vector<Real> & basis_species_molality,
                                   const std::vector<Real> & eqm_species_molality,
                                   const std::vector<Real> & kin_species_molality) const;

  void setMaxIonicStrength(Real max_ionic_strength);

  Real getMaxIonicStrength() const;

  void setMaxStoichiometricIonicStrength(Real max_stoichiometric_ionic_strength);

  Real getMaxStoichiometricIonicStrength() const;

  void setUseOnlyBasisMolality(bool use_only_basis_molality);

  Real getUseOnlyBasisMolality() const;

  void setUseOnlyClMolality(bool use_only_Cl_molality);

  Real getUseOnlyClMolality() const;

private:
  Real _max_ionic_strength;

  Real _max_stoichiometric_ionic_strength;

  bool _use_only_basis_molality;

  bool _use_only_Cl_molality;
};