- uonameName of the FunctionUserObject name to retrieve the mesh function from.
C++ Type:UserObjectName
Controllable:No
Description:Name of the FunctionUserObject name to retrieve the mesh function from.
VariableFunction
buildconstruction:Undocumented Class
The VariableFunction 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.
Overview
Example Input File Syntax
Input Parameters
- execute_onLINEARThe list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM, ALWAYS.
Default:LINEAR
C++ Type:ExecFlagEnum
Options:NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM, ALWAYS
Controllable:No
Description:The list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM, ALWAYS.
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:No
Description:Set the enabled status of the MooseObject.
Advanced Parameters
Input Files
(test/tests/thermal-mech/main_temp_mech.i)
[Mesh]
type = FileMesh
file = copper_air_bcs_tetmesh.e
displacements = 'disp_x disp_y disp_z'
[]
[Problem]
type = FEProblem
[]
[Executioner]
type = Transient
solve_type = PJFNK
petsc_options_iname = '-pc_type -pc_hypre_type -ksp_gmres_restart'
petsc_options_value = 'hypre boomeramg 101'
num_steps = 5
dt = 1
abort_on_solve_fail=True
[]
[Variables]
[temp]
order = FIRST
family = LAGRANGE
initial_condition = 300 # Start at room temperature
[]
[disp_x]
[]
[disp_y]
[]
[disp_z]
[]
[]
[AuxVariables]
[heating-local]
order = CONSTANT
family = MONOMIAL
[]
[heating-local-err]
order = CONSTANT
family = MONOMIAL
[]
[flux]
order = CONSTANT
family = MONOMIAL
[]
[flux-err]
order = CONSTANT
family = MONOMIAL
[]
[density_local]
order = CONSTANT
family = MONOMIAL
[]
[]
[AuxKernels]
[density_copy]
type = ADMaterialRealAux
property = density
variable = density_local
execute_on = timestep_end
[]
[]
[BCs]
[air-outer]
type = DirichletBC
variable = temp
boundary = 'top-outer bottom-outer left-outer right-outer front-outer back-outer'
value = 300 # (K)
[]
[./x_bot]
type = DirichletBC
variable = disp_x
boundary = 'right top-outer bottom-outer left-outer right-outer front-outer back-outer'
value = 0.0
[../]
[./y_bot]
type = DirichletBC
variable = disp_y
boundary = 'right top-outer bottom-outer left-outer right-outer front-outer back-outer'
value = 0.0
[../]
[./z_bot]
type = DirichletBC
variable = disp_z
boundary = 'right top-outer bottom-outer left-outer right-outer front-outer back-outer'
value = 0.0
[../]
[]
[UserObjects]
[uo-heating-function]
type = FunctionUserObject
variable = heating-local
execute_on = "initial"
[]
[]
[Functions]
[heating-function]
type = VariableFunction
uoname = "uo-heating-function"
[]
[]
[Materials]
[heating]
type = ADGenericFunctionMaterial
prop_names = 'volumetric_heat'
prop_values = 'heating-function'
block = '1 2'
constant_on = 'ELEMENT'
output_properties = 'volumetric_heat'
outputs = exodus
[]
[air_const_props]
type = ADGenericConstantMaterial
prop_names = 'thermal_conductivity specific_heat'
prop_values = '0.26 1'
block = 2
[]
[air_density]
type = ADOpenMCDensity
density = '0.001' # g/cm^3
displacements = 'disp_x disp_y disp_z'
block = 2
[]
[copper_const_props]
type = ADGenericConstantMaterial
prop_names = 'thermal_conductivity specific_heat'
prop_values = '3.97 0.385' # W/cm*K, J/g-K
block = 1
[]
[copper_density]
type = ADOpenMCDensity
density = '8.920' # g/cm^3
displacements = 'disp_x disp_y disp_z'
block = 1
[]
[copper_elasticity_tensor]
type = ComputeIsotropicElasticityTensor
youngs_modulus = 1.e7
poissons_ratio = 0.36
block = '1'
[]
[copper_thermal_expansion_strain]
type = ComputeThermalExpansionEigenstrain
stress_free_temperature = 300
thermal_expansion_coeff = 1.8e-5 # K^-1
temperature = temp
eigenstrain_name = copper_eigenstrain
block = '1'
[]
[copper_strain] #We use small deformation mechanics
type = ComputeSmallStrain
displacements = 'disp_x disp_y disp_z'
eigenstrain_names = 'copper_eigenstrain'
block = 1
[]
[copper_stress] #We use linear elasticity
type = ComputeLinearElasticStress
block = 1
[]
[]
[Kernels]
[heat_conduction]
type = ADHeatConduction
variable = temp
[]
[heat_conduction_time_derivative]
type = ADHeatConductionTimeDerivative
variable = temp
[]
[heat-source]
type = ADMatHeatSource
material_property = volumetric_heat
variable = temp
block = '1 2'
[]
[TensorMechanics] #Action that creates equations for disp_x and disp_y
displacements = 'disp_x disp_y disp_z'
block = 1 # Only act on air
[]
[NullKernelX]
type = NullKernel
variable = disp_x
block=2
[]
[NullKernelY]
type = NullKernel
variable = disp_y
block=2
[]
[NullKernelZ]
type = NullKernel
variable = disp_z
block=2
[]
[]
[MultiApps]
[openmc]
type = FullSolveMultiApp
app_type = OpenMCApp
execute_on = "timestep_begin"
input_files = "openmc_mech.i"
positions = '0 0 0'
library_path = ../../../openmc/lib
[]
[]
[Transfers]
[./to_openmc]
type = MoabMeshTransfer
to_multi_app = openmc
moabname = "moab"
[../]
[]
[Outputs]
exodus = true
execute_on = 'timestep_end'
[]
(test/tests/thermal/main.i)
[Mesh]
type = FileMesh
file = copper_air_bcs_tetmesh.e
[]
[Problem]
type = FEProblem
[]
[Executioner]
type = Transient
num_steps = 5
dt = 1
solve_type = NEWTON
abort_on_solve_fail=True
[]
[Variables]
[temperature]
order = FIRST
family = LAGRANGE
initial_condition = 300 # Start at room temperature
[]
[]
[AuxVariables]
[heating-local]
order = CONSTANT
family = MONOMIAL
[]
[heating-local-err]
order = CONSTANT
family = MONOMIAL
[]
[flux]
order = CONSTANT
family = MONOMIAL
[]
[flux-err]
order = CONSTANT
family = MONOMIAL
[]
[]
[BCs]
[air-outer]
type = DirichletBC
variable = temperature
boundary = 'top-outer bottom-outer left-outer right-outer front-outer back-outer'
value = 300 # (K)
[]
[]
[UserObjects]
[uo-heating-function]
type = FunctionUserObject
variable = heating-local
execute_on = "initial"
[]
[]
[Functions]
[heating-function]
type = VariableFunction
uoname = "uo-heating-function"
[]
[]
[Materials]
[copper_props]
type = ADGenericConstantMaterial
prop_names = 'thermal_conductivity specific_heat density'
prop_values = '3.97 0.385 8.920' # W/cm*K, J/g-K, g/cm^3
block = 1
[]
[air_props]
type = ADGenericConstantMaterial
prop_names = 'thermal_conductivity specific_heat density'
prop_values = '0.26 1 0.001'
block = 2
[]
[heating]
type = ADGenericFunctionMaterial
prop_names = 'volumetric_heat'
prop_values = 'heating-function'
block = '1 2'
constant_on = 'ELEMENT'
output_properties = 'volumetric_heat'
outputs = exodus
[]
[]
[Kernels]
[heat_conduction]
type = ADHeatConduction
variable = temperature
[]
[heat_conduction_time_derivative]
type = ADHeatConductionTimeDerivative
variable = temperature
[]
[heat-source]
type = ADMatHeatSource
material_property = volumetric_heat
variable = temperature
block = '1 2'
[]
[]
[MultiApps]
[openmc]
type = FullSolveMultiApp
app_type = OpenMCApp
execute_on = "timestep_begin"
input_files = "openmc.i"
positions = '0 0 0'
library_path = ../../../openmc/lib
[]
[]
[Transfers]
[./to_openmc]
type = MoabMeshTransfer
to_multi_app = openmc
moabname = "moab"
[../]
[]
[Outputs]
exodus = true
execute_on = 'timestep_end'
[]
(unit/aurora_app_inputs/variable_function.i)
[Mesh]
[mesh]
type = FileMeshGenerator
file = copper_air_bcs_tetmesh.e
[]
[]
[Problem]
type = FEProblem
solve = false
[]
[Executioner]
type = Steady
[]
[MultiApps]
[openmc]
type = FullSolveMultiApp
app_type = OpenMCApp
input_files = "function_user_object_sub.i"
library_path = ../openmc/lib
[]
[]
[Transfers]
[./to_openmc]
type = MoabMeshTransfer
direction = to_multiapp
multi_app = openmc
moabname = "moab"
apptype_from="AuroraApp"
[../]
[]
[AuxVariables]
[heating-local]
order = CONSTANT
family = MONOMIAL
[]
[]
[UserObjects]
[uo-heating-function]
type = FunctionUserObject
variable = heating-local
execute_on = "initial"
[]
[]
[Functions]
[heating-function]
type = VariableFunction
uoname = "uo-heating-function"
[]
[]
[Outputs]
console=false
[]
(unit/aurora_app_inputs/aurora.i)
[Mesh]
[meshcm]
type = FileMeshGenerator
file = copper_air_bcs_tetmesh.e
[]
[]
[Problem]
type = FEProblem
[]
[Executioner]
type = Transient
num_steps = 5
dt = 1
solve_type = NEWTON
abort_on_solve_fail=True
[]
[Variables]
[temperature]
order = CONSTANT
family = MONOMIAL
initial_condition = 300 # Start at room temperature
[]
[]
[AuxVariables]
[heating-local]
order = CONSTANT
family = MONOMIAL
[]
[]
[BCs]
[air-outer]
#type = DirichletBC
# penalty is a variant for monomials
type = PenaltyDirichletBC
penalty = 1e5
variable = temperature
boundary = 'top-outer bottom-outer left-outer right-outer front-outer back-outer'
value = 300 # (K)
[]
[]
[UserObjects]
[uo-heating-function]
type = FunctionUserObject
variable = heating-local
execute_on = "initial"
[]
[]
[Functions]
[heating-function]
type = VariableFunction
uoname = "uo-heating-function"
[]
[]
[Materials]
[copper]
type = ADGenericConstantMaterial
prop_names = 'thermal_conductivity specific_heat density'
prop_values = '397.48 385.0 8920.0' # W/m*K, J/kg-K, kg/m^3
block = 1
[]
[air]
type = ADGenericConstantMaterial
prop_names = 'thermal_conductivity specific_heat density'
prop_values = '26.3 1000 1'
block = 2
[]
[heating]
type = ADGenericFunctionMaterial
prop_names = 'volumetric_heat'
prop_values = 'heating-function'
block = '1 2'
constant_on = 'ELEMENT'
[]
[]
[Kernels]
[heat_conduction]
type = ADHeatConduction
variable = temperature
[]
[heat_conduction_time_derivative]
type = ADHeatConductionTimeDerivative
variable = temperature
[]
[heat-source]
type = ADMatHeatSource
material_property = volumetric_heat
variable = temperature
[]
[]
[MultiApps]
[openmc]
type = FullSolveMultiApp
app_type = OpenMCApp
execute_on = "timestep_begin"
input_files = "openmc.i"
positions = '0 0 0'
library_path = ../openmc/lib
[]
[]
[Transfers]
[./to_openmc]
type = MoabMeshTransfer
direction = to_multiapp
multi_app = openmc
moabname = "moab"
apptype_from="AuroraApp"
[../]
[]
[Outputs]
console=false
[]