FunctionDiracSource

under construction:Undocumented Class

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


# FunctionDiracSource

!syntax description /DiracKernels/FunctionDiracSource

## Overview

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

## Example Input File Syntax

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

!syntax parameters /DiracKernels/FunctionDiracSource

!syntax inputs /DiracKernels/FunctionDiracSource

!syntax children /DiracKernels/FunctionDiracSource

!syntax description /DiracKernels/FunctionDiracSource

Input Parameters

functionThe function to use for controlling the specified dirac source.
C++ Type:FunctionName
Options:
Description:The function to use for controlling the specified dirac source.
pointThe x,y,z coordinates of the point
C++ Type:libMesh::Point
Options:
Description:The x,y,z coordinates of the point
variableThe name of the variable that this kernel operates on
C++ Type:NonlinearVariableName
Options:
Description:The name of the variable that this kernel operates on

Required 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.
drop_duplicate_pointsTrueBy default points added to a DiracKernel are dropped if a point at the same locationhas been added before. If this option is set to false duplicate points are retainedand contribute to residual and Jacobian.
Default:True
C++ Type:bool
Options:
Description:By default points added to a DiracKernel are dropped if a point at the same locationhas been added before. If this option is set to false duplicate points are retainedand contribute to residual and Jacobian.
enableTrueSet the enabled status of the MooseObject.
Default:True
C++ Type:bool
Options:
Description:Set the enabled status of the MooseObject.
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
Options:
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

extra_matrix_tagsThe extra tags for the matrices this Kernel should fill
C++ Type:std::vector
Options:
Description:The extra tags for the matrices this Kernel should fill
extra_vector_tagsThe extra tags for the vectors this Kernel should fill
C++ Type:std::vector
Options:
Description:The extra tags for the vectors this Kernel should fill
matrix_tagssystemThe tag for the matrices this Kernel should fill
Default:system
C++ Type:MultiMooseEnum
Options:nontime system
Description:The tag for the matrices this Kernel should fill
vector_tagsnontimeThe tag for the vectors this Kernel should fill
Default:nontime
C++ Type:MultiMooseEnum
Options:nontime time
Description:The tag for the vectors this Kernel should fill

Tagging Parameters

Input Files

test/tests/dirackernels/function_dirac_source/function_dirac_source.i

test/tests/dirackernels/function_dirac_source/function_dirac_source.i

[Mesh]
  type = GeneratedMesh
  dim = 2
  xmin = -1
  xmax = 1
  ymin = -1
  ymax = 1
  nx = 5
  ny = 5
[]

[Variables]
  [./u]
    order = FIRST
    family = LAGRANGE
  [../]
[]

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

[DiracKernels]
  [./point_source]
    type = FunctionDiracSource
    variable = u
    function = switch_off
    point = '0.1 0.2 0.0'
  [../]
[]

[Functions]
  [./switch_off]
    type = ParsedFunction
    value = 'if(t < 1.0001, 1, 0)'
  [../]
[]

[BCs]
  [./external]
    type = NeumannBC
    variable = u
    boundary = '0 1 2 3'
    value = 0
  [../]
[]

[Postprocessors]
  [./total_internal_energy]
    type = ElementIntegralVariablePostprocessor
    variable = u
  [../]
[]

[Executioner]
  type = Transient
  num_steps = 5
  dt = 1
  l_tol = 1e-03
[]

[Outputs]
  exodus = true
[]

Input Parameters
Input Files

Application Usage

Physics and Syntax

Application Development

Framework Development

MOOSEDocs

Infrastructure

Questions

Information and Tools