# -*- coding: utf-8 -*- # ------------------------------------------------------------------------------- # This file is part of Code_Saturne, a general-purpose CFD tool. # # Copyright (C) 1998-2021 EDF S.A. # # This program is free software; you can redistribute it and/or modify it under # the terms of the GNU General Public License as published by the Free Software # Foundation; either version 2 of the License, or (at your option) any later # version. # # This program is distributed in the hope that it will be useful, but WITHOUT # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS # FOR A PARTICULAR PURPOSE. See the GNU General Public License for more # details. # # You should have received a copy of the GNU General Public License along with # this program; if not, write to the Free Software Foundation, Inc., 51 Franklin # Street, Fifth Floor, Boston, MA 02110-1301, USA. # ------------------------------------------------------------------------------- """ This module contains the following class: - InitializationView """ # ------------------------------------------------------------------------------- # Standard modules # ------------------------------------------------------------------------------- import logging # ------------------------------------------------------------------------------- # Third-party modules # ------------------------------------------------------------------------------- from code_saturne.Base.QtCore import * from code_saturne.Base.QtGui import * from code_saturne.Base.QtWidgets import * # ------------------------------------------------------------------------------- # Application modules import # ------------------------------------------------------------------------------- from code_saturne.Pages.SourceTermsForm import Ui_SourceTermsForm from code_saturne.model.Common import GuiParam from code_saturne.Base.QtPage import IntValidator, DoubleValidator, ComboModel from code_saturne.model.ThermalScalarModel import ThermalScalarModel from code_saturne.model.DefineUserScalarsModel import DefineUserScalarsModel from code_saturne.model.LocalizationModel import VolumicLocalizationModel, LocalizationModel from code_saturne.model.SourceTermsModel import SourceTermsModel from code_saturne.Pages.QMegEditorView import QMegEditorView from code_saturne.model.OutputVolumicVariablesModel import OutputVolumicVariablesModel from code_saturne.model.GroundwaterModel import GroundwaterModel from code_saturne.model.NotebookModel import NotebookModel # ------------------------------------------------------------------------------- # log config # ------------------------------------------------------------------------------- logging.basicConfig() log = logging.getLogger("InitializationView") log.setLevel(GuiParam.DEBUG) # ------------------------------------------------------------------------------- # Main class # ------------------------------------------------------------------------------- class SourceTermsView(QWidget, Ui_SourceTermsForm): """ """ def __init__(self, parent=None): """ Constructor """ QWidget.__init__(self, parent) Ui_SourceTermsForm.__init__(self) self.setupUi(self) self.parent = parent self.case = None self.mdl = None self.notebook = None self.zone = None self.zone_id = None self.therm = None self.th_sca = None self.th_sca_name = None self.scalar = None # FIXME really useful to duplicate this comboBox for ground water flow? self.modelSpecies = ComboModel(self.comboBoxSpecies, 1, 1) self.modelSpecies2 = ComboModel(self.comboBoxSpecies2, 1, 1) self.setConnections() def setConnections(self): self.comboBoxSpecies.activated[str].connect(self.slotSpeciesChoice) self.pushButtonMomentum.clicked.connect(self.slotMomentumFormula) self.pushButtonThermal.clicked.connect(self.slotThermalFormula) self.pushButtonSpecies.clicked.connect(self.slotSpeciesFormula) self.comboBoxSpecies2.activated[str].connect(self.slotSpeciesChoice) self.pushButtonSpecies2.clicked.connect(self.slotSpeciesGroundWaterFormula) self.pushButtonRichards.clicked.connect(self.slotRichardsFormula) def setup(self, case, zone_name): self.case = case self.mdl = SourceTermsModel(self.case) self.notebook = NotebookModel(self.case) self.therm = ThermalScalarModel(self.case) self.th_sca = DefineUserScalarsModel(self.case) self.case.undoStopGlobal() for zone in LocalizationModel('VolumicZone', self.case).getZones(): if zone.getLabel() == zone_name: self.zone = zone self.zone_id = str(zone.getCodeNumber()) if self.zone.isNatureActivated("source_term"): self.setViewFromCase() else: self.displayDefaultView() self.setEnabled(False) self.case.undoStartGlobal() def displayDefaultView(self): if GroundwaterModel(self.case).getGroundwaterModel() != "off": self.groupBoxStandard.hide() self.groupBoxTransport.show() if self.zone.getNature()['momentum_source_term'] == "on": self.groupBoxRichards.show() else: self.groupBoxRichards.hide() else: self.groupBoxStandard.show() self.groupBoxRichards.hide() self.groupBoxTransport.hide() def setViewFromCase(self): # Thermal scalar scalar_name, unit = self.getThermalLabelAndUnit() self.th_sca_name = scalar_name if GroundwaterModel(self.case).getGroundwaterModel() != "off": self.groupBoxStandard.hide() self.groupBoxTransport.show() if self.zone.getNature()['momentum_source_term'] == "on": self.groupBoxRichards.show() else: self.groupBoxRichards.hide() else: self.groupBoxStandard.show() self.groupBoxRichards.hide() self.groupBoxTransport.hide() scalar_list = self.th_sca.getUserScalarNameList() for s in self.th_sca.getScalarsVarianceList(): if s in scalar_list: scalar_list.remove(s) if scalar_list: for scalar in scalar_list: self.scalar = scalar self.modelSpecies.addItem(self.tr(scalar), self.scalar) self.modelSpecies2.addItem(self.tr(scalar), self.scalar) self.modelSpecies.setItem(str_model=self.scalar) self.modelSpecies2.setItem(str_model=self.scalar) self.initialize() def initialize(self): """ Initialize widget when a new volumic zone_info is chosen """ if self.isSourceTermActived("momentum"): self.labelMomentum.show() self.pushButtonMomentum.show() exp = self.mdl.getMomentumFormula(self.zone_id) if exp: self.pushButtonMomentum.setToolTip(exp) self.pushButtonMomentum.setStyleSheet("background-color: green") else: self.pushButtonMomentum.setStyleSheet("background-color: red") if GroundwaterModel(self.case).getGroundwaterModel() != "off": self.groupBoxRichards.show() exp = self.mdl.getRichardsFormula(self.zone_id) if exp: self.pushButtonRichards.setToolTip(exp) self.pushButtonRichards.setStyleSheet("background-color: green") else: self.pushButtonRichards.setStyleSheet("background-color: red") else: self.groupBoxRichards.hide() else: self.labelMomentum.hide() self.pushButtonMomentum.hide() self.groupBoxRichards.hide() if self.isSourceTermActived("thermal"): self.pushButtonThermal.show() self.labelThermal.show() if self.case.module_name() != "code_saturne" and self.th_sca_name == "": self.th_sca_name = 'enthalpy' exp = self.mdl.getThermalFormula(self.zone_id, self.th_sca_name) if exp: self.pushButtonThermal.setToolTip(exp) self.pushButtonThermal.setStyleSheet("background-color: green") else: self.pushButtonThermal.setStyleSheet("background-color: red") else: self.pushButtonThermal.hide() self.labelThermal.hide() if self.isSourceTermActived("scalar"): self.comboBoxSpecies.show() self.pushButtonSpecies.show() self.labelSpecies.show() exp = self.mdl.getSpeciesFormula(self.zone_id, self.scalar) if exp: self.pushButtonSpecies.setToolTip(exp) self.pushButtonSpecies.setStyleSheet("background-color: green") else: self.pushButtonSpecies.setStyleSheet("background-color: red") if GroundwaterModel(self.case).getGroundwaterModel() != "off": self.groupBoxTransport.show() exp = self.mdl.getGroundWaterSpeciesFormula(self.zone_id, self.scalar) if exp: self.pushButtonSpecies2.setToolTip(exp) self.pushButtonSpecies2.setStyleSheet("background-color: green") else: self.pushButtonSpecies2.setStyleSheet("background-color: red") else: self.groupBoxTransport.hide() else: self.comboBoxSpecies.hide() self.pushButtonSpecies.hide() self.labelSpecies.hide() self.groupBoxTransport.hide() @pyqtSlot(str) def slotSpeciesChoice(self, text): """ INPUT label for choice of species """ self.scalar = self.modelSpecies.dicoV2M[str(text)] exp = self.mdl.getSpeciesFormula(self.zone_id, self.scalar) if exp: self.pushButtonSpecies.setToolTip(exp) self.pushButtonSpecies.setStyleSheet("background-color: green") else: self.pushButtonSpecies.setToolTip("Use the formula editor to define a source term for this species.") self.pushButtonSpecies.setStyleSheet("background-color: red") @pyqtSlot() def slotMomentumFormula(self): """ Set momentumFormula of the source term """ exa = """#example:\n tau = 10.; # relaxation time (s)\n vel_x_imp = 1.5; #target velocity (m/s)\n Su = rho * (vel_x_imp - u) / tau;\n dSudu = - rho / tau; # Jacobian of the source term""" exp, req, sym = self.mdl.getMomentumFormulaComponents(self.zone_id) knf = [('rho', 'density')] zone_name = self.zone.getLabel() dialog = QMegEditorView(parent=self, function_type='src', zone_name=zone_name, variable_name="momentum", expression=exp, required=req, symbols=sym, known_fields=knf, examples=exa, source_type='momentum_source_term') if dialog.exec_(): result = dialog.get_result() log.debug("slotFormulaVelocity -> %s" % str(result)) self.mdl.setMomentumFormula(self.zone_id, str(result)) self.pushButtonMomentum.setToolTip(result) self.pushButtonMomentum.setStyleSheet("background-color: green") @pyqtSlot() def slotSpeciesFormula(self): """ """ exa = """#example:\nS = rho / volume;\ndS = 0.;""" exp, req, sym, knf = self.mdl.getSpeciesFormulaComponents(self.zone_id, self.scalar) zone_name = self.zone.getLabel() dialog = QMegEditorView(parent=self, function_type='src', zone_name=zone_name, variable_name=self.scalar, expression=exp, required=req, symbols=sym, known_fields=knf, examples=exa, source_type='scalar_source_term') if dialog.exec_(): result = dialog.get_result() log.debug("slotFormulaSpecies -> %s" % str(result)) self.mdl.setSpeciesFormula(self.zone_id, self.scalar, str(result)) self.pushButtonSpecies.setToolTip(result) self.pushButtonSpecies.setStyleSheet("background-color: green") @pyqtSlot() def slotSpeciesGroundWaterFormula(self): """ """ exa = """#example: """ exp, req, sym, knf = self.mdl.getGroundWaterSpeciesFormulaComponents(self.zone_id, self.scalar) zone_name = self.zone.getLabel() dialog = QMegEditorView(parent=self, function_type='src', zone_name=zone_name, variable_name=self.scalar, expression=exp, required=req, symbols=sym, known_fields=knf, examples=exa, source_type='scalar_source_term') if dialog.exec_(): result = dialog.get_result() log.debug("slotSpeciesGroundWaterFormula -> %s" % str(result)) self.mdl.setGroundWaterSpeciesFormula(self.zone_id, self.scalar, str(result)) self.pushButtonSpecies2.setToolTip(result) self.pushButtonSpecies2.setStyleSheet("background-color: green") @pyqtSlot() def slotRichardsFormula(self): """ """ exa = """#example: """ exp, req, sym = self.mdl.getRichardsFormulaComponents(self.zone_id) zone_name = self.zone.getLabel() dialog = QMegEditorView(parent=self, function_type='src', zone_name=zone_name, variable_name="richards", expression=exp, required=req, symbols=sym, examples=exa, source_type='momentum_source_term') if dialog.exec_(): result = dialog.get_result() log.debug("slotRichardsFormula -> %s" % str(result)) self.mdl.setRichardsFormula(self.zone_id, str(result)) self.pushButtonRichards.setToolTip(result) self.pushButtonRichards.setStyleSheet("background-color: green") @pyqtSlot() def slotThermalFormula(self): """ Input the initial formula of thermal scalar """ exa = """#example: """ exp, req, sym, knf = self.mdl.getThermalFormulaComponents(self.zone_id, self.th_sca_name) zone_name = self.zone.getLabel() dialog = QMegEditorView(parent=self, function_type='src', zone_name=zone_name, variable_name=self.th_sca_name, expression=exp, required=req, symbols=sym, known_fields=knf, examples=exa, source_type='thermal_source_term') if dialog.exec_(): result = dialog.get_result() log.debug("slotFormulaThermal -> %s" % str(result)) self.mdl.setThermalFormula(self.zone_id, self.th_sca_name, str(result)) self.pushButtonThermal.setToolTip(result) self.pushButtonThermal.setStyleSheet("background-color: green") def getThermalLabelAndUnit(self): """ Define the type of model is used. """ model = self.therm.getThermalScalarModel() if model != 'off': th_sca_name = self.therm.getThermalScalarName() if model == "temperature_celsius": unit = "oC" elif model == "temperature_kelvin": unit = "Kelvin" elif model == "enthalpy": unit = "J/kg" elif model == "potential_temperature": unit = "Kelvin" else: unit = None else: th_sca_name = '' unit = None self.th_sca_name = th_sca_name return th_sca_name, unit def isSourceTermActived(self, nature: str) -> bool: source_term = nature + "_source_term" zone_info = self.zone.getNature() if source_term in zone_info: return zone_info[source_term] == "on" else: return False # ------------------------------------------------------------------------------- # Testing part # ------------------------------------------------------------------------------- if __name__ == "__main__": pass # ------------------------------------------------------------------------------- # End # -------------------------------------------------------------------------------