TabulatedBicubicFluidProperties

Fluid properties using bicubic interpolation on tabulated values provided

See TabulatedFluidProperties for more information on how to use this object.

warningwarning

Third order fluid property interpolations are not always monotonous. This is exacerbated by composition when using alternative variable sets such as (specific volume, specific internal energy). If this arises and is observed to remove the uniqueness of the numerical solution, lower order interpolation should be considered.

Input Parameters

  • allow_fp_and_tabulationFalseWhether to allow the two sources of data concurrently

    Default:False

    C++ Type:bool

    Controllable:No

    Description:Whether to allow the two sources of data concurrently

  • create_pT_interpolationsTrueWhether to load (from file) or create (from a fluid property object) properties interpolations from pressure and temperature

    Default:True

    C++ Type:bool

    Controllable:No

    Description:Whether to load (from file) or create (from a fluid property object) properties interpolations from pressure and temperature

  • create_ve_interpolationsFalseWhether to load (from file) or create (from a fluid property object) properties interpolations from pressure and temperature

    Default:False

    C++ Type:bool

    Controllable:No

    Description:Whether to load (from file) or create (from a fluid property object) properties interpolations from pressure and temperature

  • execute_onTIMESTEP_ENDThe list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, POSTCHECK, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM.

    Default:TIMESTEP_END

    C++ Type:ExecFlagEnum

    Options:NONE, INITIAL, LINEAR, 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, the available options include NONE, INITIAL, LINEAR, NONLINEAR, POSTCHECK, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM.

  • fluid_property_output_fileName of the CSV file which can be output with the tabulation. This file can then be read as a 'fluid_property_file'

    C++ Type:FileName

    Controllable:No

    Description:Name of the CSV file which can be output with the tabulation. This file can then be read as a 'fluid_property_file'

  • fluid_property_ve_fileName of the csv file containing the tabulated (v,e) fluid property data.

    C++ Type:FileName

    Controllable:No

    Description:Name of the csv file containing the tabulated (v,e) fluid property data.

  • fluid_property_ve_output_fileName of the CSV file which can be output with the (v,e) tabulation. This file can then be read as a 'fluid_property_ve_file'

    C++ Type:FileName

    Controllable:No

    Description:Name of the CSV file which can be output with the (v,e) tabulation. This file can then be read as a 'fluid_property_ve_file'

  • fpThe name of the FluidProperties UserObject

    C++ Type:UserObjectName

    Controllable:No

    Description:The name of the FluidProperties UserObject

  • interpolated_propertiesdensity enthalpy internal_energy viscosityProperties to interpolate if no data file is provided

    Default:density enthalpy internal_energy viscosity

    C++ Type:MultiMooseEnum

    Options:density, enthalpy, internal_energy, viscosity, k, c, cv, cp, entropy, pressure, temperature

    Controllable:No

    Description:Properties to interpolate if no data file is provided

  • 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

    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.

  • use_log_grid_eFalseOption to use a base-10 logarithmically-spaced grid for specific internal energy instead of a linearly-spaced grid.

    Default:False

    C++ Type:bool

    Controllable:No

    Description:Option to use a base-10 logarithmically-spaced grid for specific internal energy instead of a linearly-spaced grid.

Optional Parameters

  • T_initial_guess400Temperature initial guess for Newton Method variable set conversion

    Default:400

    C++ Type:double

    Controllable:No

    Description:Temperature initial guess for Newton Method variable set conversion

  • p_initial_guess200000Pressure initial guess for Newton Method variable set conversion

    Default:200000

    C++ Type:double

    Controllable:No

    Description:Pressure initial guess for Newton Method variable set conversion

  • tolerance1e-08Tolerance for 2D Newton variable set conversion

    Default:1e-08

    C++ Type:double

    Controllable:No

    Description:Tolerance for 2D Newton variable set conversion

Variable Set Conversions Newton Solve 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).

  • allow_imperfect_jacobiansFalsetrue to allow unimplemented property derivative terms to be set to zero for the AD API

    Default:False

    C++ Type:bool

    Controllable:No

    Description:true to allow unimplemented property derivative terms to be set to zero for the AD API

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

  • 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

  • fp_typesingle-phase-fpType of the fluid property object

    Default:single-phase-fp

    C++ Type:FPType

    Controllable:No

    Description:Type of the fluid property 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

  • construct_pT_from_veFalseIf the lookup table (p, T) as functions of (v, e) should be constructed.

    Default:False

    C++ Type:bool

    Controllable:No

    Description:If the lookup table (p, T) as functions of (v, e) should be constructed.

  • construct_pT_from_vhFalseIf the lookup table (p, T) as functions of (v, h) should be constructed.

    Default:False

    C++ Type:bool

    Controllable:No

    Description:If the lookup table (p, T) as functions of (v, h) should be constructed.

Variable Set Conversion Parameters

  • e_maxMaximum specific internal energy for tabulated data.

    C++ Type:double

    Controllable:No

    Description:Maximum specific internal energy for tabulated data.

  • e_minMinimum specific internal energy for tabulated data.

    C++ Type:double

    Controllable:No

    Description:Minimum specific internal energy for tabulated data.

  • out_of_bounds_behaviorthrowProperty evaluation behavior when evaluated outside the user-specified or tabulation-specified bounds

    Default:throw

    C++ Type:MooseEnum

    Options:ignore, throw, declare_invalid, set_to_closest_bound

    Controllable:No

    Description:Property evaluation behavior when evaluated outside the user-specified or tabulation-specified bounds

  • pressure_max5e+07Maximum pressure for tabulated data.

    Default:5e+07

    C++ Type:double

    Controllable:No

    Description:Maximum pressure for tabulated data.

  • pressure_min100000Minimum pressure for tabulated data.

    Default:100000

    C++ Type:double

    Controllable:No

    Description:Minimum pressure for tabulated data.

  • temperature_max500Maximum temperature for tabulated data.

    Default:500

    C++ Type:double

    Controllable:No

    Description:Maximum temperature for tabulated data.

  • temperature_min300Minimum temperature for tabulated data.

    Default:300

    C++ Type:double

    Controllable:No

    Description:Minimum temperature for tabulated data.

  • v_maxMaximum specific volume for tabulated data.

    C++ Type:double

    Controllable:No

    Description:Maximum specific volume for tabulated data.

  • v_minMinimum specific volume for tabulated data.

    C++ Type:double

    Controllable:No

    Description:Minimum specific volume for tabulated data.

Tabulation And Interpolation Bounds Parameters

  • fluid_property_fileName of the csv file containing the tabulated fluid property data.

    C++ Type:FileName

    Controllable:No

    Description:Name of the csv file containing the tabulated fluid property data.

Tabulation File Read/Write Parameters

  • num_T100Number of points to divide temperature range.

    Default:100

    C++ Type:unsigned int

    Controllable:No

    Description:Number of points to divide temperature range.

  • num_e100Number of points to divide specific internal energy range for (v,e) lookups.

    Default:100

    C++ Type:unsigned int

    Controllable:No

    Description:Number of points to divide specific internal energy range for (v,e) lookups.

  • num_p100Number of points to divide pressure range.

    Default:100

    C++ Type:unsigned int

    Controllable:No

    Description:Number of points to divide pressure range.

  • num_v100Number of points to divide specific volume range for (v,e) lookups.

    Default:100

    C++ Type:unsigned int

    Controllable:No

    Description:Number of points to divide specific volume range for (v,e) lookups.

  • use_log_grid_vFalseOption to use a base-10 logarithmically-spaced grid for specific volume instead of a linearly-spaced grid.

    Default:False

    C++ Type:bool

    Controllable:No

    Description:Option to use a base-10 logarithmically-spaced grid for specific volume instead of a linearly-spaced grid.

Tabulation And Interpolation Discretization Parameters