FluidPropertiesInterrogator.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 "GeneralUserObject.h"
#include "nlohmann/json.h"

class FluidProperties;
class SinglePhaseFluidProperties;
class VaporMixtureFluidProperties;
class TwoPhaseFluidProperties;
class TwoPhaseNCGFluidProperties;
class TwoPhaseNCGPartialPressureFluidProperties;

class FluidPropertiesInterrogator : public GeneralUserObject
{
public:
  static InputParameters validParams();

  FluidPropertiesInterrogator(const InputParameters & parameters);

  virtual void initialize() override;
  virtual void execute() override;
  virtual void finalize() override;

protected:
  InputParameters compute1Phase(const SinglePhaseFluidProperties * const fp_1phase,
                                bool throw_error_if_no_match);

  InputParameters computeVaporMixture(bool throw_error_if_no_match);

  InputParameters compute2Phase();

  std::map<std::string, bool>
  getSpecifiedSetMap(const std::vector<std::vector<std::string>> & parameter_sets,
                     const std::string & fp_type,
                     bool throw_error_if_no_match) const;

  void buildJSON1Phase(nlohmann::json & json, const InputParameters & params);

  void buildJSON2Phase(nlohmann::json & json, const InputParameters & params);

  void buildJSONVaporMixture(nlohmann::json & json, const InputParameters & params);

  void outputASCII1Phase(const std::string & description, const InputParameters & params);

  void outputASCII2Phase(const InputParameters & params);

  void outputASCIIVaporMixture(const InputParameters & params);

  void outputHeader(const std::string & header) const;

  void outputProperty(const std::string & name, const Real & value, const std::string & units);

  void outputStaticProperties(const InputParameters & params);

  void outputStagnationProperties(const InputParameters & params);

  void outputVaporMixtureStaticProperties(const InputParameters & params);

  void outputVaporMixtureStagnationProperties(const InputParameters & params);

  const bool & _json;
  const FluidProperties * const _fp;
  const SinglePhaseFluidProperties * const _fp_1phase;
  const TwoPhaseFluidProperties * const _fp_2phase;
  const TwoPhaseNCGFluidProperties * const _fp_2phase_ncg;
  const TwoPhaseNCGPartialPressureFluidProperties * const _fp_2phase_ncg_partial_pressure;

  const bool _has_1phase;
  const bool _has_vapor_mixture;
  const bool _has_2phase;
  const bool _has_2phase_ncg;
  const bool _has_2phase_ncg_partial_pressure;

  const SinglePhaseFluidProperties * const _fp_liquid;
  const SinglePhaseFluidProperties * const _fp_vapor;
  const VaporMixtureFluidProperties * const _fp_vapor_mixture;

  bool _nan_encountered;

  const unsigned int & _precision;
};