FileTransportMaterial

buildconstruction:Undocumented Class

The FileTransportMaterial has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

Provides the neutron group velocity (), neutron group total cross-section (), and the scattering cross-section moments () for transport problems. The material properties are imported from files provided by the user. The user many also provide volumetric neutron source moments through the input parameter system.

Overview

Example Input File Syntax

Input Parameters

  • file_nameThe file to extract cross-sections from. The path of the file should be relative to the input deck (.i) file.

    C++ Type:std::string

    Controllable:No

    Description:The file to extract cross-sections from. The path of the file should be relative to the input deck (.i) file.

  • source_material_idThe material ID used by the cross-section source to identify cross-sections for different geometric regions.

    C++ Type:std::string

    Controllable:No

    Description:The material ID used by the cross-section source to identify cross-sections for different geometric regions.

Required Parameters

  • add_heatingFalseWhether or not this material should provide fission heating cross-sections.

    Default:False

    C++ Type:bool

    Controllable:No

    Description:Whether or not this material should provide fission heating cross-sections.

  • blockThe list of blocks (ids or names) that this object will be applied

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

    Controllable:No

    Description:The list of blocks (ids or names) that this object will be applied

  • boundaryThe list of boundaries (ids or names) from the mesh where this object applies

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

    Controllable:No

    Description:The list of boundaries (ids or names) from the mesh where this object applies

  • computeTrueWhen false, MOOSE will not call compute methods on this material. The user must call computeProperties() after retrieving the MaterialBase via MaterialBasePropertyInterface::getMaterialBase(). Non-computed MaterialBases are not sorted for dependencies.

    Default:True

    C++ Type:bool

    Controllable:No

    Description:When false, MOOSE will not call compute methods on this material. The user must call computeProperties() after retrieving the MaterialBase via MaterialBasePropertyInterface::getMaterialBase(). Non-computed MaterialBases are not sorted for dependencies.

  • constant_onNONEWhen ELEMENT, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps.When SUBDOMAIN, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps. Evaluations on element qps will be skipped

    Default:NONE

    C++ Type:MooseEnum

    Options:NONE, ELEMENT, SUBDOMAIN

    Controllable:No

    Description:When ELEMENT, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps.When SUBDOMAIN, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps. Evaluations on element qps will be skipped

  • cross_section_sourcedetectThe source which generated the cross-sections. Used for parsing different cross-section formats. If set to 'detect' the material will attempt to determine the source and parse accordingly.

    Default:detect

    C++ Type:MooseEnum

    Options:detect, gnat, openmc

    Controllable:No

    Description:The source which generated the cross-sections. Used for parsing different cross-section formats. If set to 'detect' the material will attempt to determine the source and parse accordingly.

  • declare_suffixAn optional suffix parameter that can be appended to any declared 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 declared properties. The suffix will be prepended with a '_' character.

  • group_sourceThe external source moments for all energy groups.

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

    Unit:(no unit assumed)

    Controllable:No

    Description:The external source moments for all energy groups.

  • has_fissionFalseWhether or not the transport system accounts for fission reactions.

    Default:False

    C++ Type:bool

    Controllable:No

    Description:Whether or not the transport system accounts for fission reactions.

  • is_diffusionFalseWhether or not the transport system is initializing a diffusion approximation scheme.

    Default:False

    C++ Type:bool

    Controllable:No

    Description:Whether or not the transport system is initializing a diffusion approximation scheme.

  • is_saafTrueWhether or not the transport system is initializing a SAAF scheme.

    Default:True

    C++ Type:bool

    Controllable:No

    Description:Whether or not the transport system is initializing a SAAF scheme.

  • num_groups0The number of energy groups the energy spectrum is divided into.

    Default:0

    C++ Type:unsigned int

    Controllable:No

    Description:The number of energy groups the energy spectrum is divided into.

  • particle_typeneutronThe type of particle to be consuming material property data.

    Default:neutron

    C++ Type:MooseEnum

    Options:neutron, photon

    Controllable:No

    Description:The type of particle to be consuming material property data.

  • saaf_c1Stabilization parameter c for the SAAF-CFEM scheme. eta = 0 and c = 1 is equivalent to the SAAF approach with no void treatment. Use with caution.

    Default:1

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:Stabilization parameter c for the SAAF-CFEM scheme. eta = 0 and c = 1 is equivalent to the SAAF approach with no void treatment. Use with caution.

  • saaf_eta0.5Stabilization parameter eta for the SAAF-CFEM scheme. eta = 0 and c = 1 is equivalent to the SAAF approach with no void treatment. Use with caution.

    Default:0.5

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:Stabilization parameter eta for the SAAF-CFEM scheme. eta = 0 and c = 1 is equivalent to the SAAF approach with no void treatment. Use with caution.

  • source_anisotropy0The external source anisotropy of the medium.

    Default:0

    C++ Type:unsigned int

    Controllable:No

    Description:The external source anisotropy of the medium.

  • transport_systemName of the transport system which will consume the provided material properties. If one is not provided the first transport system will be used.

    C++ Type:std::string

    Controllable:No

    Description:Name of the transport system which will consume the provided material properties. If one is not provided the first transport system will be used.

Optional 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.

  • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

    Default:True

    C++ Type:bool

    Controllable:No

    Description:Determines whether this object is calculated using an implicit or explicit form

  • seed0The seed for the master random number generator

    Default:0

    C++ Type:unsigned int

    Controllable:No

    Description:The seed for the master random number generator

  • 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

  • output_propertiesList of material properties, from this material, to output (outputs must also be defined to an output type)

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

    Controllable:No

    Description:List of material properties, from this material, to output (outputs must also be defined to an output type)

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

    Default:none

    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

Outputs 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