prj_process_variable
prj_process_variable.Rd
tag: process_variable
Usage
prj_process_variable(
name,
components,
order,
initial_condition,
boundary_conditions = NULL,
source_terms = NULL,
mesh = NULL,
deactivated_subdomains = NULL,
compensate_non_equilibrium_initial_residuum = NULL
)
Arguments
- name
string: The name of the process variable
- components
string | double:
- order
string | double:
- initial_condition
string:
- boundary_conditions
list, prj_boundary_condition:
- source_terms
Optional: list, prj_source_term:
- mesh
Optional: string: list:
- deactivated_subdomains
Optional: list, prj_deactivated_subdomain:
- compensate_non_equilibrium_initial_residuum
Optional: string
Examples
prj_process_variable(
name = "pressure",
components = 1,
order = 1,
initial_condition = "pressure0",
boundary_conditions = list(
boundary_condition = prj_boundary_condition(
type = "Neumann",
parameter = "flux_in",
geometrical_set = "cube_1x1x1_geometry",
geometry = "left",
component = 0
)
)
)
#> $name
#> [1] "pressure"
#>
#> $components
#> [1] 1
#>
#> $order
#> [1] 1
#>
#> $initial_condition
#> [1] "pressure0"
#>
#> $boundary_conditions
#> $boundary_conditions$boundary_condition
#> $type
#> [1] "Neumann"
#>
#> $parameter
#> [1] "flux_in"
#>
#> $geometrical_set
#> [1] "cube_1x1x1_geometry"
#>
#> $geometry
#> [1] "left"
#>
#> $component
#> [1] 0
#>
#> $mesh
#> NULL
#>
#> $alpha
#> NULL
#>
#> $u_0
#> NULL
#>
#> $constraint_type
#> NULL
#>
#> $constraining_process_variable
#> NULL
#>
#> $constraint_threshold
#> NULL
#>
#> $constraint_direction
#> NULL
#>
#> $area_parameter
#> NULL
#>
#> $bc_object
#> NULL
#>
#> $flush_stdout
#> NULL
#>
#> $property_name
#> NULL
#>
#> $initial_value_parameter
#> NULL
#>
#> $constant_name
#> NULL
#>
#> $coefficient_current_variable_name
#> NULL
#>
#> $coefficient_other_variable_name
#> NULL
#>
#> $coefficient_mixed_variables_name
#> NULL
#>
#> $threshold_parameter
#> NULL
#>
#> $comparison_operator
#> NULL
#>
#> $time_interval
#> NULL
#>
#> $xpath
#> [1] "process_variables/process_variable/boundary_conditions/boundary_condition"
#>
#> $attr_names
#> character(0)
#>
#> $flatten_on_exp
#> character(0)
#>
#> attr(,"class")
#> [1] "prj_boundary_condition"
#>
#>
#> $source_terms
#> NULL
#>
#> $mesh
#> NULL
#>
#> $deactivated_subdomains
#> NULL
#>
#> $compensate_non_equilibrium_initial_residuum
#> NULL
#>
#> $xpath
#> [1] "process_variables/process_variable"
#>
#> $attr_names
#> character(0)
#>
#> $flatten_on_exp
#> character(0)
#>
#> attr(,"class")
#> [1] "prj_process_variable"