SerpentConnector.hxx

Go to the documentation of this file.

/*
  This file is part of MURE,
  Copyright (C) 2007-2021 MURE developers.
 
  MURE is free software: you can redistribute it and/or modify
  it under the terms of the GNU Lesser General Public License as published by
  the Free Software Foundation, either version 3 of the License, or
  (at your option) any later version.
 
  MURE 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 Lesser General Public License for more details.
 
  You should have received a copy of the GNU Lesser General Public License
  along with MURE.  If not, see <http://www.gnu.org/licenses/>.
*/
 
#ifndef SERPENTCONNECTOR_H
#define SERPENTCONNECTOR_H
#include <iomanip>
#include <string>
 
#include "ConnectorPlugin.hxx"
#include "MUREGlobal.hxx"
#include "SerpentNode.hxx"
#include "SerpentTally.hxx"
#include "LatticeCell.hxx"
using namespace std;
 
#include "SerpentResultOutputReader.hxx"
#include "SerpentDetectorOutputReader.hxx"
 
namespace Serpent
{
 
class Connector: public ConnectorPlugin
{
  public:
    Connector();
    ~Connector() override;
    Connector(const Connector &plugin);
    Connector *Clone() override; 
 
    void BuildXSDIR() override; 
 
    void BuildDetectors() override; 
    void UpdateSigmaPhiDetectors() override;    
    void BuildMultiGroupDetectors() override;
    void BuildMultiGroupDetectors(vector < Material *> &MaterialVector);
    void UpdateMultiGroupSigmaPhiDetectors() override;  
    void UpdateMultiGroupSigmaPhiDetectors(vector < Material *> &MaterialVector);   
    void UpdateKeff() override; 
    void FindDetectorMCUserFile() override; 
    void SumOutputDetectorFile(string DetectorBaseFileName, int N, string SumDetectorFileName) override;
    string GetMCDetectorOutputFileName(string InputFileName, bool OnlyKeff = false) override;
 
    string GetMCExecCommandString(string InputFileName, string Arg = "", string FileArg = "") override;
 
    void BuildMCFile(string FileString = "") override; 
 
    void BuildPinCells(bool Auto = false) override;
 
    void FindMissingVolume() override;
    void UpdateTallyBinVolume() override;       
 
    string Print(Cell *TheCell) override; 
    string Print(Material *mat) override; 
    string PrintModeratorMaterial(Material *mat) override; 
    string Print(Transformation *Transfo) override; 
    void WriteMCFileWithoutDetector(string FileName = "inp", bool tmpvol = false) override; 
 
 
    void BuildTHMultiGroupDetectors() override;
    void UpdateTHMultiGroupSigmaPhiDetectors() override;
 
    Node *GetNewNode(int sign) override;
    SimpleBin *GetNewSimpleBin() override
    {
        return new SimpleBin;   
    }
    MureGroupBin *GetNewGroupBin() override
    {
        return new MureGroupBin;   
    }
    string PrintId(Material *material) override;
    string PrintId(Cell *cell) override;
    string PrintMaterialId(int id) override; 
 
  protected:
    DetectorOutputReader *fDetectorFileReader; 
 
  private:
    void CheckXSDIR();  
    void EncapsulateGeometry();
 
    void BuildGlobalTallies();
    void UpdateGlobalTallies();
 
    void ReadDetectorFile();
 
    void FillTallyBinVolume();
    void StochasticVolumeCalculation(); 
    void AddTestMaterialForCell(Cell *oldCell); 
    void AddTestMaterialForPinCell(PinCell *oldCell);
    Material *GetTestMaterial();
 
    string PrintLattice(LatticeCell *TheLattice);
    unsigned GetLatticeType(LatticeCell *TheLattice); 
    unsigned GetNumberOfLatticeDimentions(unsigned LatticeType) const;
    string PrintLatticeCardHead(LatticeCell *TheLattice);
    string PrintLatticeLayout(LatticeCell *TheLattice);
 
    string PrintPinCell(PinCell *ThePinCell); 
 
    string PrintBasicCell(Cell *TheCell); 
 
 
    string PrintAllMaterials(); 
    string PrintAllSurfaceCards(bool tmpvol);
    string PrintAllPinCells(); 
    string PrintAllCells(); 
 
    string PrintAllSpecialCards();
    string PrintAllTransformationCards();
    string PrintMCSource();
    string PrintAllTallies();
    void PrintAllEnergyGrids(ofstream &Out); 
 
    void WriteSerpentFile(string FileName, bool tmpvol = false);
    void CopySerpentFile(string FileName, bool tmpvol = false);
 
    string PrintMaterialModeratorOption(Material *mat);
    string PrintModeratorName(Material *mat, unsigned nucleusIndex);
 
    string PrintSerpentDopplerBroadening(Material *mat);
 
    string GetResultFileName(const string &inputFileName) const; 
    string GetSumResultFileName(const string &SumDetectorFileName);
 
    void SetBoundaryCondition(Shape_ptr S); 
 
    static string MATERIAL_NAME_PREFIX;
    const static string LATTICE_COMMAND;
    const static string CELL_NAME_PREFIX; 
    const static string CELL_COMMAND;
    const static char COMMENT_SIGN = '%';
    const static unsigned X_HEX_LATTICE_TYPE = 2;
    const static unsigned Y_HEX_LATTICE_TYPE = 3;
    const static unsigned CUBOID_LATTICE_2D_TYPE = 1;
    const static unsigned CUBOID_LATTICE_3D_TYPE = 11;
    const static unsigned X_HEX_LATTICE_3D_TYPE = 12;
    const static unsigned Y_HEX_LATTICE_3D_TYPE = 13; 
 
};
 
}
 
#endif // SERPENTCONNECTOR_H