TRISOMonteCarloPointSourceFromFile

Description

TRISOMonteCarloPointSourceFromFile reads TRISO particle point source values from CSV files. The CSV files of time and point_source for all particles at every time step will typically be generated by a previous Monte Carlo simulation. The number of files (typically corresponds to the number of time steps performed by the Monte Carlo simulation) needs to be specified, and their file base names (before appended sequence numbers) should be provided to file_base_source and file_base_time.

Example Input Syntax

[VectorPostprocessors<<<{"href": "../../syntax/VectorPostprocessors/index.html"}>>>]
  [heat_source]
    type = TRISOMonteCarloPointSourceFromFile<<<{"description": "Read TRISO particle point source values from csv files generated by Monte Carlo simulation.", "href": "TRISOMonteCarloPointSourceFromFile.html"}>>>
    file_base_time<<<{"description": "File base name of CSV files holding time"}>>> = monte_carlo_out_time
    file_base_source<<<{"description": "File base name of CSV files holding source"}>>> = monte_carlo_out_release_heat_inc
    x_header_in_file<<<{"description": "The abscissa header in the data file"}>>> = 'time:time'
    y_header_in_file<<<{"description": "The ordinate header in the data file"}>>> = 'release_heat_inc:release_heat_inc'
    source_name<<<{"description": "Name of the VectorPostprocessor containing point source values from csv files."}>>> = heat_inc
    num_files<<<{"description": "Number of CSV files."}>>> = 2
    num_particles<<<{"description": "Number of TRISO particles."}>>> = 100
    format<<<{"description": "Format of csv data file that is in either in columns or rows"}>>> = columns
    execute_on<<<{"description": "The list of flag(s) indicating when this object should be executed. For a description of each flag, see https://mooseframework.inl.gov/source/interfaces/SetupInterface.html."}>>> = 'INITIAL TIMESTEP_BEGIN'
  []
  [point_source_output]
    type = TRISOMonteCarloPointSourceOutput<<<{"description": "Output TRISO particle point source values and locations.", "href": "TRISOMonteCarloPointSourceOutput.html"}>>>
    vector_postprocessor<<<{"description": "Name of the VectorPostprocessor containing point source values from TRISO sub-application."}>>> = heat_source
    value_name<<<{"description": "Name of column containing values."}>>> = heat_inc
    point_source_location<<<{"description": "The UserObject that generates random particle locations."}>>> = point_source_location
  []
[]
(test/tests/triso_pebble/3D_pebble_from_csv.i)

Input Parameters

  • file_base_sourceFile base name of CSV files holding source

    C++ Type:FileName

    Controllable:No

    Description:File base name of CSV files holding source

  • file_base_timeFile base name of CSV files holding time

    C++ Type:FileName

    Controllable:No

    Description:File base name of CSV files holding time

  • num_filesNumber of CSV files.

    C++ Type:unsigned int

    Controllable:No

    Description:Number of CSV files.

  • num_particlesNumber of TRISO particles.

    C++ Type:unsigned int

    Controllable:No

    Description:Number of TRISO particles.

  • source_nameName of the VectorPostprocessor containing point source values from csv files.

    C++ Type:std::string

    Controllable:No

    Description:Name of the VectorPostprocessor containing point source values from csv files.

  • x_header_in_fileThe abscissa header in the data file

    C++ Type:std::string

    Controllable:No

    Description:The abscissa header in the data file

  • y_header_in_fileThe ordinate header in the data file

    C++ Type:std::string

    Controllable:No

    Description:The ordinate header in the data file

Required Parameters

  • contains_complete_historyFalseSet this flag to indicate that the values in all vectors declared by this VPP represent a time history (e.g. with each invocation, new values are added and old values are never removed). This changes the output so that only a single file is output and updated with each invocation

    Default:False

    C++ Type:bool

    Controllable:No

    Description:Set this flag to indicate that the values in all vectors declared by this VPP represent a time history (e.g. with each invocation, new values are added and old values are never removed). This changes the output so that only a single file is output and updated with each invocation

  • formatcolumnsFormat of csv data file that is in either in columns or rows

    Default:columns

    C++ Type:MooseEnum

    Options:columns, rows

    Controllable:No

    Description:Format of csv data file that is in either in columns or rows

  • padding4The number of digits for extension suffix (e.g., out_0001.csv)

    Default:4

    C++ Type:unsigned int

    Controllable:No

    Description:The number of digits for extension suffix (e.g., out_0001.csv)

  • parallel_typeREPLICATEDSet how the data is represented within the VectorPostprocessor (VPP); 'distributed' indicates that data within the VPP is distributed and no auto communication is performed, this setting will result in parallel output within the CSV output; 'replicated' indicates that the data within the VPP is correct on processor 0, the data will automatically be broadcast to all processors unless the '_auto_broadcast' param is set to false within the validParams function.

    Default:REPLICATED

    C++ Type:MooseEnum

    Options:DISTRIBUTED, REPLICATED

    Controllable:No

    Description:Set how the data is represented within the VectorPostprocessor (VPP); 'distributed' indicates that data within the VPP is distributed and no auto communication is performed, this setting will result in parallel output within the CSV output; 'replicated' indicates that the data within the VPP is correct on processor 0, the data will automatically be broadcast to all processors unless the '_auto_broadcast' param is set to false within the validParams function.

Optional Parameters

  • allow_duplicate_execution_on_initialFalseIn the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).

    Default:False

    C++ Type:bool

    Controllable:No

    Description:In the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).

  • execute_onTIMESTEP_ENDThe list of flag(s) indicating when this object should be executed. For a description of each flag, see https://mooseframework.inl.gov/source/interfaces/SetupInterface.html.

    Default:TIMESTEP_END

    C++ Type:ExecFlagEnum

    Options:XFEM_MARK, NONE, INITIAL, LINEAR, NONLINEAR_CONVERGENCE, NONLINEAR, POSTCHECK, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM

    Controllable:No

    Description:The list of flag(s) indicating when this object should be executed. For a description of each flag, see https://mooseframework.inl.gov/source/interfaces/SetupInterface.html.

  • execution_order_group0Execution order groups are executed in increasing order (e.g., the lowest number is executed first). Note that negative group numbers may be used to execute groups before the default (0) group. Please refer to the user object documentation for ordering of user object execution within a group.

    Default:0

    C++ Type:int

    Controllable:No

    Description:Execution order groups are executed in increasing order (e.g., the lowest number is executed first). Note that negative group numbers may be used to execute groups before the default (0) group. Please refer to the user object documentation for ordering of user object execution within a group.

  • force_postauxFalseForces the UserObject to be executed in POSTAUX

    Default:False

    C++ Type:bool

    Controllable:No

    Description:Forces the UserObject to be executed in POSTAUX

  • force_preauxFalseForces the UserObject to be executed in PREAUX

    Default:False

    C++ Type:bool

    Controllable:No

    Description:Forces the UserObject to be executed in PREAUX

  • force_preicFalseForces the UserObject to be executed in PREIC during initial setup

    Default:False

    C++ Type:bool

    Controllable:No

    Description:Forces the UserObject to be executed in PREIC during initial setup

Execution Scheduling Parameters

  • control_tagsAdds user-defined labels for accessing object parameters via control logic.

    C++ Type:std::vector<std::string>

    Controllable:No

    Description:Adds user-defined labels for accessing object parameters via control logic.

  • enableTrueSet the enabled status of the MooseObject.

    Default:True

    C++ Type:bool

    Controllable:Yes

    Description:Set the enabled status of the MooseObject.

  • outputsVector of output names where you would like to restrict the output of variables(s) associated with this object

    C++ Type:std::vector<OutputName>

    Controllable:No

    Description:Vector of output names where you would like to restrict the output of variables(s) associated with this object

  • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

    Default:False

    C++ Type:bool

    Controllable:No

    Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

Advanced Parameters

  • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

    C++ Type:MaterialPropertyName

    Unit:(no unit assumed)

    Controllable:No

    Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

  • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

    Default:False

    C++ Type:bool

    Controllable:No

    Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

Material Property Retrieval Parameters

Input Files