RampIC

under construction:Undocumented Class

The RampIC 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.


# RampIC

!syntax description /ICs/RampIC

## Overview

!! Replace these lines with information regarding the RampIC object.

## Example Input File Syntax

!! Describe and include an example of how to use the RampIC object.

!syntax parameters /ICs/RampIC

!syntax inputs /ICs/RampIC

!syntax children /ICs/RampIC

Linear ramp along the x-axis with given values at the left and right extreme points.

Input Parameters

value_leftThe value on left (xmin) boundary.
C++ Type:double
Options:
Description:The value on left (xmin) boundary.
value_rightThe value on right (xmax) boundary.
C++ Type:double
Options:
Description:The value on right (xmax) boundary.
variableThe variable this initial condition is supposed to provide values for.
C++ Type:VariableName
Options:
Description:The variable this initial condition is supposed to provide values for.

Required Parameters

blockThe list of block ids (SubdomainID) that this object will be applied
C++ Type:std::vector
Options:
Description:The list of block ids (SubdomainID) that this object will be applied
boundaryThe list of boundary IDs from the mesh where this boundary condition applies
C++ Type:std::vector
Options:
Description:The list of boundary IDs from the mesh where this boundary condition applies

Optional Parameters

control_tagsAdds user-defined labels for accessing object parameters via control logic.
C++ Type:std::vector
Options:
Description:Adds user-defined labels for accessing object parameters via control logic.
enableTrueSet the enabled status of the MooseObject.
Default:True
C++ Type:bool
Options:
Description:Set the enabled status of the MooseObject.
ignore_uo_dependencyFalseWhen set to true, a UserObject retrieved by this IC will not be executed before the this IC
Default:False
C++ Type:bool
Options:
Description:When set to true, a UserObject retrieved by this IC will not be executed before the this IC

Advanced Parameters

Input Files

modules/phase_field/test/tests/ADCHSoretDiffusion/simple_transient_diffusion_with_soret.i
modules/phase_field/test/tests/initial_conditions/RampIC.i
modules/phase_field/examples/measure_interface_energy/1Dinterface_energy.i

modules/phase_field/test/tests/ADCHSoretDiffusion/simple_transient_diffusion_with_soret.i

[Mesh]
  type = GeneratedMesh
  dim = 1
  nx = 10
[]

[Variables]
  [./c]
  [../]
  [./mu]
  [../]
[]

[AuxVariables]
  [./T]
    [./InitialCondition]
      type = RampIC
      value_left = 900
      value_right = 1000
    [../]
  [../]
[]

[Kernels]
  [./conc]
    type = ADCHSplitConcentration
    variable = c
    chemical_potential_var = mu
    mobility = chemical_mobility_prop
  [../]
  [./chempot]
    type = ADCHSplitChemicalPotential
    variable = mu
    chemical_potential = mu_prop
  [../]
  [./soret]
    type = ADCHSoretMobility
    variable = c
    T = T
    mobility = thermal_mobility_prop
  [../]
  [./time]
    type = ADTimeDerivative
    variable = c
  [../]
[]

[Materials]
  [./chemical_potential]
    type = ADPiecewiseLinearInterpolationMaterial
    property = mu_prop
    variable = c
    x = '0 1'
    y = '0 1'
  [../]
  [./chemical_mobility_prop]
    type = GenericConstantMaterial
    prop_names = chemical_mobility_prop
    prop_values = 0.1
  [../]
  [./thermal_mobility_prop]
    type = GenericConstantMaterial
    prop_names = thermal_mobility_prop
    prop_values = -20
  [../]
[]

[BCs]
  [./leftc]
    type = DirichletBC
    variable = c
    boundary = left
    value = 0
  [../]
  [./rightc]
    type = DirichletBC
    variable = c
    boundary = right
    value = 1
  [../]
[]

[Executioner]
  type = Transient
  solve_type = NEWTON
  petsc_options_iname = '-pc_type -ksp_grmres_restart -sub_ksp_type -sub_pc_type -pc_asm_overlap'
  petsc_options_value = 'asm      31                  preonly       lu           2'
  dt = 0.1
  num_steps = 20
[]

[Preconditioning]
  [./smp]
     type = SMP
     full = true
  [../]
[]

[Outputs]
  exodus = true
[]

modules/phase_field/test/tests/initial_conditions/RampIC.i

[Mesh]
  type = GeneratedMesh
  dim = 1
  nx = 30
  xmax = 13
  xmin = -5
  elem_type = EDGE
[]

[Variables]
  [./c]
    order = FIRST
    family = LAGRANGE
    scaling = 1e1
    [./InitialCondition]
      type = RampIC
      variable = c
      value_left = -0.2
      value_right = 1.3
    [../]
  [../]
[]

[Problem]
  type = FEProblem
  solve = false
  kernel_coverage_check = false
[]

[Executioner]
  type = Steady
  solve_type = PJFNK
  petsc_options_iname = '-pc_type -pc_hypre_type'
  petsc_options_value = 'hypre boomeramg'
[]

[Outputs]
  execute_on = 'timestep_end'
  exodus = true
[]

modules/phase_field/examples/measure_interface_energy/1Dinterface_energy.i

[Mesh]
  type = GeneratedMesh
  dim = 1
  nx = 100
  xmax = 100
  xmin = 0
  elem_type = EDGE
[]

[AuxVariables]
  [./local_energy]
    order = CONSTANT
    family = MONOMIAL
  [../]
[]

[AuxKernels]
  [./local_free_energy]
    type = TotalFreeEnergy
    variable = local_energy
    kappa_names = kappa_c
    interfacial_vars = c
  [../]
[]

[Variables]
  [./c]
    order = FIRST
    family = LAGRANGE
    scaling = 1e1
    [./InitialCondition]
      type = RampIC
      variable = c
      value_left = 0
      value_right = 1
    [../]
  [../]
  [./w]
    order = FIRST
    family = LAGRANGE
  [../]
[]

[Kernels]
  [./c_res]
    type = SplitCHParsed
    variable = c
    f_name = F
    kappa_name = kappa_c
    w = w
  [../]
  [./w_res]
    type = SplitCHWRes
    variable = w
    mob_name = M
  [../]
  [./time]
    type = CoupledTimeDerivative
    variable = w
    v = c
  [../]

[]

[Functions]
  [./Int_energy]
    type = ParsedFunction
    vals = 'total_solute Cleft Cright Fleft Fright volume'
    value = '((total_solute-Cleft*volume)/(Cright-Cleft))*Fright+(volume-(total_solute-Cleft*volume)/(Cright-Cleft))*Fleft'
    vars = 'total_solute Cleft Cright Fleft Fright volume'
  [../]
  [./Diff]
    type = ParsedFunction
    vals = 'total_free_energy total_no_int'
    vars = 'total_free_energy total_no_int'
    value = total_free_energy-total_no_int
  [../]
[]

[Materials]
  [./consts]
    type = GenericConstantMaterial
    prop_names  = 'kappa_c M'
    prop_values = '25      150'
  [../]
  [./Free_energy]
    type = DerivativeParsedMaterial
    f_name = F
    function = 'c^2*(c-1)^2'
    args = c
    derivative_order = 2
  [../]
[]

[Postprocessors]
  # The total free energy of the simulation cell to observe the energy reduction.
  [./total_free_energy]
    type = ElementIntegralVariablePostprocessor
    variable = local_energy
  [../]

  # for testing we also monitor the total solute amount, which should be conserved,
  # gives Cavg in % for this problem.
  [./total_solute]
    type = ElementIntegralVariablePostprocessor
    variable = c
  [../]
  # Get simulation cell size (1D volume) from postprocessor
  [./volume]
    type = ElementIntegralMaterialProperty
    mat_prop = 1
  [../]
  # Find concentration in each phase using SideAverageValue
  [./Cleft]
    type = SideAverageValue
    boundary = left
    variable = c
  [../]
  [./Cright]
    type = SideAverageValue
    boundary = right
    variable = c
  [../]
  # Find local energy in each phase by checking boundaries
  [./Fleft]
    type = SideAverageValue
    boundary = left
    variable = local_energy
  [../]
  [./Fright]
    type = SideAverageValue
    boundary = right
    variable = local_energy
  [../]
  # Use concentrations and energies to find total free energy without any interface,
  # only applies once equilibrium is reached!!
  # Difference between energy with and without interface
  # gives interface energy per unit area.
  [./total_no_int]
    type = FunctionValuePostprocessor
    function = Int_energy
  [../]
  [./Energy_of_Interface]
    type = FunctionValuePostprocessor
    function = Diff
  [../]
[]

[Preconditioning]
  # This preconditioner makes sure the Jacobian Matrix is fully populated. Our
  # kernels compute all Jacobian matrix entries.
  # This allows us to use the Newton solver below.
  [./SMP]
    type = SMP
    full = true
  [../]
[]

[Executioner]
  type = Transient
  scheme = 'bdf2'

  # Automatic differentiation provides a _full_ Jacobian in this example
  # so we can safely use NEWTON for a fast solve
  solve_type = 'NEWTON'

  l_max_its = 15
  l_tol = 1.0e-6

  nl_max_its = 15
  nl_rel_tol = 1.0e-10
  nl_abs_tol = 1.0e-4

  start_time = 0.0
  # make sure that the result obtained for the interfacial free energy is fully converged
  end_time   = 40

  [./TimeStepper]
    type = SolutionTimeAdaptiveDT
    dt = 0.5
  [../]
[]

[Outputs]
  gnuplot = true
  csv = true
  [./exodus]
    type = Exodus
    show = 'c local_energy'
    execute_on = 'failed initial nonlinear timestep_end final'
  [../]
  [./console]
    type = Console
    execute_on = 'FAILED INITIAL NONLINEAR TIMESTEP_END final'
  [../]
  perf_graph = true
[]

Input Parameters
Input Files

Application Usage

Physics and Syntax

Application Development

Framework Development

MOOSEDocs

Infrastructure

Questions

Information and Tools