- 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
- log_extensionTrueUse a logarithmic extension for low saturation to avoid capillary pressure going to infinity. Default is true. Set to false if your capillary pressure depends on spatially-dependent variables other than saturation, as the log-extension C++ code for this case has yet to be implemented
Default:True
C++ Type:bool
Controllable:No
Description:Use a logarithmic extension for low saturation to avoid capillary pressure going to infinity. Default is true. Set to false if your capillary pressure depends on spatially-dependent variables other than saturation, as the log-extension C++ code for this case has yet to be implemented
- oil_viscosityViscosity of oil (gas) phase. It is assumed this is double the water-phase viscosity. (Note that this effective saturation is mostly useful for 2-phase, not single-phase.)
C++ Type:double
Controllable:No
Description:Viscosity of oil (gas) phase. It is assumed this is double the water-phase viscosity. (Note that this effective saturation is mostly useful for 2-phase, not single-phase.)
- pc_max1e+09Maximum capillary pressure (Pa). Must be > 0. Default is 1e9
Default:1e+09
C++ Type:double
Controllable:No
Description:Maximum capillary pressure (Pa). Must be > 0. Default is 1e9
- 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.
- sat_lr0Liquid residual saturation. Must be between 0 and 1. Default is 0
Default:0
C++ Type:double
Controllable:No
Description:Liquid residual saturation. Must be between 0 and 1. Default is 0
- scale_ratioThis is porosity / permeability / beta^2, where beta may be chosen by the user. It has dimensions [time]
C++ Type:double
Controllable:No
Description:This is porosity / permeability / beta^2, where beta may be chosen by the user. It has dimensions [time]
- shifteffective saturation is a function of (Pc - shift)
C++ Type:double
Controllable:No
Description:effective saturation is a function of (Pc - shift)
- 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.
PorousFlowCapillaryPressureRSC
Rogers-Stallybrass-Clements version of effective saturation for the water phase, valid for residual saturations = 0, and viscosityOil = 2 * viscosityWater. seff_water = 1 / sqrt(1 + exp((Pc - shift) / scale)), where scale = 0.25 * scale_ratio * oil_viscosity.
The Rogers-Stallybrass-Clements capillary relationship is (Rogers et al., 1983) when the oil viscosity is exactly twice the water viscosity. This is of limited use in real simulations, and is only used in the Porous Flow module for comparison with the analytical solutions offered by the authors for multi-phase infiltration and drainage problems.
Only effective saturation as a function of capillary pressure is available.
Input 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).
- 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
- 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
Input Files
References
- C. Rogers, M. P. Stallybrass, and D. L. Clements.
On two phase filtration under gravity and with boundary infiltration: application of a Backlund transformation.
Nonlinear Analysis, Theory, Methods and Applications, 7:785–799, 1983.[BibTeX]