ConnectorPlugin.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 _CONNECTORPLUGIN_HXX_
#define _CONNECTORPLUGIN_HXX_
 
#include <string>
 
#include "MCSource.hxx"
#include "MathNode.hxx"
#include "Cell.hxx"
#include "MureSimpleBin.hxx"
#include "MureGroupBin.hxx"
 
class Cell;
class MCSource;
class Material;
class MathNode;
class MureGroupBin;
class MureSimpleBin;
class Transformation;
 
 
class ConnectorPlugin
{
 
  public :
    ConnectorPlugin();
    virtual ~ConnectorPlugin();
    ConnectorPlugin(const ConnectorPlugin &plugin);
    virtual ConnectorPlugin *Clone() = 0; 
 
    virtual void BuildXSDIR() = 0;
 
 
    virtual void BuildDetectors() = 0;  
    virtual void UpdateSigmaPhiDetectors() = 0;
    virtual void BuildMultiGroupDetectors() = 0;
 
    virtual void BuildTHMultiGroupDetectors() = 0;
    virtual void UpdateTHMultiGroupSigmaPhiDetectors() = 0;
    bool IsTHMultiGroupTalliesUsed()
    {
        return fTHMultigroupTallies;   
    }
 
    virtual void UpdateMultiGroupSigmaPhiDetectors() = 0;
    virtual void UpdateKeff() = 0;  
    virtual void FindDetectorMCUserFile() = 0; 
    virtual void SumOutputDetectorFile(string DetectorBaseFileName, int N, string SumDetectorFileName) = 0;
 
    void SetMCSource(MCSource *source);      
    MCSource *GetMCSource()
    {
        return fSource;   
    }
 
    virtual string GetMCExecCommandString(string InputFileName, string Arg = "", string FileArg = "")
    {
        return "";
    }
    string GetMCGlobalOutputFileName(string InputFileName)
    {
        return InputFileName + fMCGlobalOutputSuffix;
    }
    virtual string GetMCDetectorOutputFileName(string InputFileName, bool OnlyKeff = false)
    {
        return InputFileName + fMCDetectorOutputSuffix;
    }
 
    virtual void BuildMCFile(string FileString = "") = 0; 
    virtual void BuildPinCells(bool Auto = false) = 0;
 
    virtual void FindMissingVolume() = 0; 
    virtual void UpdateTallyBinVolume() = 0;        
 
    virtual string Print(Cell *TheCell) = 0; 
    virtual string Print(Material *mat) = 0; 
    virtual string PrintModeratorMaterial(Material *mat) = 0;
    virtual string Print(Transformation *Transfo) = 0;
 
    virtual void WriteMCFileWithoutDetector(string FileName = "inp", bool tmpvol = false) {} 
 
 
    virtual MathNode *GetNewNode(int sign);
    virtual MureSimpleBin *GetNewSimpleBin() = 0;
    virtual MureGroupBin *GetNewGroupBin() = 0;
    virtual string PrintId(Material *material) = 0;
    virtual string PrintId(Cell *cell) = 0;
    virtual string PrintMaterialId(int id)
    {
        return string();   
    }
    bool IsSerpentConnector()
    {
        return fIsSerpentConnector;   
    }
 
  protected:
    bool IsVolumeCalculationNeeded(); 
 
    bool fRebuildDetector;
    MCSource *fSource;  
    string fMCGlobalOutputSuffix; 
    string fMCDetectorOutputSuffix;
    bool fPinCellBuilt;     
 
    bool fTHMultigroupTallies;          
 
    bool fIsSerpentConnector;
};
 
#endif