Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -19,37 +19,52 @@ This is output for every hierarchical level in the syntax.
[Functions]

[./*]
active = '__all__ ' # "If specified only the blocks named will be visited and made active"
# Group: ""
inactive = (no_default) # "If specified blocks matching these identifiers will be skipped."
# Group: ""
isObjectAction = 1 # "Indicates that this is a MooseObjectAction."
# Group: ""
type = (required) # "A string representing the Moose Object that will be built by this Action"
# Group: ""
active = '__all__ ' # "If specified only the blocks named will be visited and made active"
# Unit: ""
# Group: ""
control_tags = (no_default) # "Adds user-defined labels for accessing object parameters via control
# logic."
# Unit: ""
# Group: "Advanced"
inactive = (no_default) # "If specified blocks matching these identifiers will be skipped."
# Unit: ""
# Group: ""
type = (required) # "A string representing the Moose Object that will be built by this Action"
# Unit: ""
# Group: ""

[./<types>]

[./<ADParsedFunction>]
[./<ParsedFunction>]
# "Function created by parsing a string"
control_tags = (no_default) # "Adds user-defined labels for accessing object parameters via
# control logic."
# Group: "Advanced"
enable = 1 # "Set the enabled status of the MooseObject."
# Group: "Advanced"
execute_on = LINEAR # "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."
# Group: ""
type = ADParsedFunction # ""
# Group: ""
vals = (no_default) # "Constant numeric values, postprocessor names, or function names
# for vars."
# Group: ""
value = (required) # "The user defined function."
# Group: ""
vars = (no_default) # "Variables (excluding t,x,y,z) that are bound to the values provided
# by the corresponding items in the vals vector."
# Group: ""
control_tags = (no_default) # "Adds user-defined labels for accessing object parameters via control
# logic."
# Unit: ""
# Group: "Advanced"
enable = 1 # "Set the enabled status of the MooseObject."
# Unit: ""
# Group: "Advanced"
expression = (required) # "The user defined function."
# Unit: ""
# Group: ""
symbol_names = (no_default) # "Symbols (excluding t,x,y,z) that are bound to the values provided
# by the corresponding items in the vals vector."
# Unit: ""
# Group: ""
symbol_values = (no_default) # "Constant numeric values, postprocessor names, function names,
# and scalar variables corresponding to the symbols in symbol_names."
# Unit: ""
# Group: ""
type = ParsedFunction # ""
# Unit: ""
# Group: ""
vals = (no_default) # "Constant numeric values, postprocessor names, function names,
# and scalar variables for vars."
# Unit: ""
# Group: ""
vars = (no_default) # "Variables (excluding t,x,y,z) that are bound to the values provided
# by the corresponding items in the vals vector."
# Unit: ""
# Group: ""
[../]
```
Original file line number Diff line number Diff line change
Expand Up @@ -15,156 +15,112 @@ We can see that each parameter is listed with additional meta data for how it ma
set in the input file.

```
'ADParsedFunction_type'{
'ParsedFunction_type'{
InputTmpl=MooseBlock
InputName="ADParsedFunction"
InputName="ParsedFunction"
InputType=type_sub
InputDefault="insert_name_here"
Description="Function created by parsing a string"
MinOccurs=0
MaxOccurs=NoLimit
decl{
MinOccurs=0
MaxOccurs=1
ValType=String
}
'active'{
InputTmpl=MooseParam
InputType=key_array
InputName="active"
Description="If specified only the blocks named will be visited and made active"
MinOccurs=0
MaxOccurs=1
'value'{
MinOccurs=0
MaxOccurs=NoLimit
ValType=String
InputDefault="__all__"
}
} % end parameter active
}
'control_tags'{
InputTmpl=MooseParam
InputType=key_array
InputName="control_tags"
Description="Adds user-defined labels for accessing object parameters via control logic."
MinOccurs=0
MaxOccurs=1
'value'{
MinOccurs=0
MaxOccurs=NoLimit
ValType=String
}
} % end parameter control_tags
}
'enable'{
InputTmpl=MooseParam
InputType=key_value
InputName="enable"
Description="Set the enabled status of the MooseObject."
MinOccurs=0
MaxOccurs=1
'value'{
MinOccurs=1
MaxOccurs=1
ValType=String
ValEnums=[ true false 1 0 on off ]
InputDefault="1"
}
} % end parameter enable
'execute_on'{
}
ChildAtLeastOne=[ "../../GlobalParams/expression/value" "expression" ]
'expression'{
InputTmpl=MooseParam
InputType=key_array
InputName="execute_on"
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."
MinOccurs=0
InputName="expression"
Description="The user defined function."
MaxOccurs=1
'value'{
MinOccurs=0
MaxOccurs=NoLimit
ValType=String
ValEnums=[ "NONE" "INITIAL" "LINEAR" "NONLINEAR" "TIMESTEP_END" "TIMESTEP_BEGIN" "FINAL" "CUSTOM" "ALWAYS" ]
InputDefault="LINEAR"
}
} % end parameter execute_on
}
'inactive'{
InputTmpl=MooseParam
InputType=key_array
InputName="inactive"
Description="If specified blocks matching these identifiers will be skipped."
MinOccurs=0
MaxOccurs=1
'value'{
MinOccurs=0
MaxOccurs=NoLimit
ValType=String
}
} % end parameter inactive
'isObjectAction'{
}
'symbol_names'{
InputTmpl=MooseParam
InputType=key_value
InputName="isObjectAction"
Description="Indicates that this is a MooseObjectAction."
MinOccurs=0
InputType=key_array
InputName="symbol_names"
Description="Symbols (excluding t,x,y,z) that are bound to the values provided by the corresponding items in the vals vector."
MaxOccurs=1
'value'{
}
}
'symbol_values'{
InputTmpl=MooseParam
InputType=key_array
InputName="symbol_values"
Description="Constant numeric values, postprocessor names, function names, and scalar variables corresponding to the symbols in symbol_names."
MaxOccurs=1
'value'{
MinOccurs=1
MaxOccurs=1
ValType=String
ValEnums=[ true false 1 0 on off ]
InputDefault="1"
}
} % end parameter isObjectAction
}
'type'{
InputTmpl=MooseParam
InputType=key_value
InputName="type"
MinOccurs=0
MaxOccurs=1
'value'{
MinOccurs=1
MaxOccurs=1
ValType=String
InputDefault="ADParsedFunction"
InputDefault="ParsedFunction"
}
} % end parameter type
}
'vals'{
InputTmpl=MooseParam
InputType=key_array
InputName="vals"
Description="Constant numeric values, postprocessor names, or function names for vars."
MinOccurs=0
MaxOccurs=1
'value'{
MinOccurs=0
MaxOccurs=NoLimit
ValType=String
}
} % end parameter vals
ChildAtLeastOne=[ "../../GlobalParams/value/value" "value" ]
'value'{
InputTmpl=MooseParam
InputType=key_array
InputName="value"
Description="The user defined function."
MinOccurs=0
Description="Constant numeric values, postprocessor names, function names, and scalar variables for vars."
MaxOccurs=1
'value'{
MinOccurs=0
MaxOccurs=NoLimit
ValType=String
}
} % end parameter value
}
'vars'{
InputTmpl=MooseParam
InputType=key_array
InputName="vars"
Description="Variables (excluding t,x,y,z) that are bound to the values provided by the corresponding items in the vals vector."
MinOccurs=0
MaxOccurs=1
'value'{
MinOccurs=0
MaxOccurs=NoLimit
ValType=String
}
} % end parameter vars
} % end block ADParsedFunction_type
}
} % end block ParsedFunction_type
```
51 changes: 33 additions & 18 deletions framework/doc/content/source/outputs/formatters/YAMLFormatter.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,57 +14,72 @@ block and the [MooseParsedFunction.md]. We can see metadata about each parameter
C++ type, their default, or their description.

```
- name: /Functions/ADParsedFunction
- name: /Functions/ParsedFunction
description: |

parameters:
- name: control_tags
required: No
default: !!str
cpp_type: std::__1::vector<std::__1::basic_string<char, std::__1::char_traits<char>, std::__1::allocator<char> >, std::__1::allocator<std::__1::basic_string<char, std::__1::char_traits<char>, std::__1::allocator<char> > > >
cpp_type: std::vector<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >, std::allocator<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > > >
group_name: 'Advanced'
doc_unit:
description: |
Adds user-defined labels for accessing object parameters via control logic.
- name: enable
required: No
default: !!str 1
cpp_type: bool
group_name: 'Advanced'
doc_unit:
description: |
Set the enabled status of the MooseObject.
- name: execute_on
- name: expression
required: Yes
default: !!str
cpp_type: FunctionExpression
group_name:
doc_unit:
description: |
The user defined function.
- name: symbol_names
required: No
default: !!str LINEAR
cpp_type: ExecFlagEnum
default: !!str
cpp_type: std::vector<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >, std::allocator<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > > >
group_name:
doc_unit:
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.
Symbols (excluding t,x,y,z) that are bound to the values provided by the corresponding items in the vals vector.
- name: symbol_values
required: No
default: !!str
cpp_type: std::vector<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >, std::allocator<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > > >
group_name:
doc_unit:
description: |
Constant numeric values, postprocessor names, function names, and scalar variables corresponding to the symbols in symbol_names.
- name: type
required: No
default: !!str ADParsedFunction
cpp_type: std::__1::basic_string<char, std::__1::char_traits<char>, std::__1::allocator<char> >
default: !!str ParsedFunction
cpp_type: std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >
group_name:
doc_unit:
description: |

- name: vals
required: No
default: !!str
cpp_type: std::__1::vector<std::__1::basic_string<char, std::__1::char_traits<char>, std::__1::allocator<char> >, std::__1::allocator<std::__1::basic_string<char, std::__1::char_traits<char>, std::__1::allocator<char> > > >
group_name:
description: |
Constant numeric values, postprocessor names, or function names for vars.
- name: value
required: Yes
default: !!str
cpp_type: FunctionExpression
cpp_type: std::vector<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >, std::allocator<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > > >
group_name:
doc_unit:
description: |
The user defined function.
Constant numeric values, postprocessor names, function names, and scalar variables for vars.
- name: vars
required: No
default: !!str
cpp_type: std::__1::vector<std::__1::basic_string<char, std::__1::char_traits<char>, std::__1::allocator<char> >, std::__1::allocator<std::__1::basic_string<char, std::__1::char_traits<char>, std::__1::allocator<char> > > >
cpp_type: std::vector<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >, std::allocator<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > > >
group_name:
doc_unit:
description: |
Variables (excluding t,x,y,z) that are bound to the values provided by the corresponding items in the vals vector.
subblocks:
Expand Down
Loading