SplineFunction

under construction:Undocumented Class

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


# SplineFunction

!syntax description /Functions/SplineFunction

## Overview

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

## Example Input File Syntax

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

!syntax parameters /Functions/SplineFunction

!syntax inputs /Functions/SplineFunction

!syntax children /Functions/SplineFunction

!syntax description /Functions/SplineFunction

Input Parameters

xThe abscissa values
C++ Type:std::vector
Options:
Description:The abscissa values
yThe ordinate values
C++ Type:std::vector
Options:
Description:The ordinate values

Required Parameters

componentxThe component of the geometry point to interpolate with
Default:x
C++ Type:MooseEnum
Options:x y z
Description:The component of the geometry point to interpolate with
yp11e+30The value of the first derivative of the interpolating function at point 1
Default:1e+30
C++ Type:double
Options:
Description:The value of the first derivative of the interpolating function at point 1
ypn1e+30The value of the first derivative of the interpolating function at point n
Default:1e+30
C++ Type:double
Options:
Description:The value of the first derivative of the interpolating function at point n

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.

Advanced Parameters

Input Files

test/tests/utils/spline_interpolation/spline_interpolation.i
test/tests/ics/function_ic/spline_function.i

test/tests/utils/spline_interpolation/spline_interpolation.i

[Mesh]
  type = GeneratedMesh
  dim = 1
  nx = 4
  xmin = -1
  xmax = 3
  elem_type = EDGE2
[]

[Functions]
  [./spline_fn]
    type = SplineFunction
    x = '-1  0 3'
    y = '0.5 0 3'
  [../]
[]

[Variables]
  [./u]
    order = THIRD
    family = HERMITE
  [../]
[]

[Kernels]
  [./diff]
    type = Diffusion
    variable = u
  [../]

  [./ufn]
    type = SplineFFn
    variable = u
    function = spline_fn
  [../]
[]

[BCs]
  [./sides]
    type = FunctionDirichletBC
    variable = u
    boundary = '0 1'
    function = spline_fn
  [../]
[]

[Postprocessors]
  [./l2_err]
    type = ElementL2Error
    variable = u
    function = spline_fn
    execute_on = 'initial timestep_end'
  [../]
[]

[Executioner]
  type = Steady
  solve_type = NEWTON
[]

[Outputs]
  exodus = true
[]

test/tests/ics/function_ic/spline_function.i

#
# Test the gradient calculation in spline function and the gradient pass-through in FunctionIC
#

[Mesh]
  type = GeneratedMesh
  dim = 2
  xmin = 0
  xmax = 3
  ymin = 0
  ymax = 1
  nx = 10
  ny = 2
[]

[Variables]
  [./u]
    order = THIRD
    family = HERMITE
  [../]
[]

[Functions]
  [./spline_function]
    type = SplineFunction
    x = '0 1 2 3'
    y = '0 1 0 1'
  [../]
[]

[ICs]
  [./u_ic]
    type = FunctionIC
    variable = 'u'
    function = spline_function
  [../]
[]

[Executioner]
  type = Steady
[]

[Problem]
  solve = false
[]

[Outputs]
  file_base = spline
  [./OverSampling]
    type = Exodus
    refinements = 3
  [../]
[]

Input Parameters
Input Files

Application Usage

Physics and Syntax

Application Development

Framework Development

MOOSEDocs

Infrastructure

Questions

Information and Tools