Newer
Older
#'r2ogs6_process_variable
#'@description tag: process_variable
#'@param name string: The name of the process variable
#'@param components string | double:
#'@param order string | double:
#'@param initial_condition string:
#'@param boundary_conditions list, r2ogs6_boundary_condition:
#'@param source_terms Optional: list, r2ogs6_source_term:
#'@param mesh Optional: string: list:
#'@param deactivated_subdomains Optional: list, r2ogs6_deactivated_subdomain:
#'@export
r2ogs6_process_variable <- function(name,
components,
order,
initial_condition,
boundary_conditions = NULL,
source_terms = NULL,
mesh = NULL,
deactivated_subdomains = NULL){
components <- coerce_string_to_numeric(components)
order <- coerce_string_to_numeric(order)
new_r2ogs6_process_variable(name,
components,
order,
initial_condition,
boundary_conditions,
source_terms,
mesh,
deactivated_subdomains)
}
new_r2ogs6_process_variable <- function(name,
components,
order,
initial_condition,
boundary_conditions = NULL,
source_terms = NULL,
mesh = NULL,
deactivated_subdomains = NULL){
assertthat::assert_that(assertthat::is.string(name))
assertthat::assert_that(assertthat::is.number(components))
assertthat::assert_that(assertthat::is.number(order))
assertthat::assert_that(assertthat::is.string(initial_condition))
if(!is.null(boundary_conditions)){
validate_wrapper_list(boundary_conditions,
"r2ogs6_boundary_condition")
}
if(!is.null(source_terms)){
validate_wrapper_list(source_terms,
"r2ogs6_source_term")
}
validate_is_null_or_string(mesh)
if(!is.null(deactivated_subdomains)){
validate_wrapper_list(deactivated_subdomains,
"r2ogs6_deactivated_subdomain")
}
structure(list(name = name,
components = components,
order = order,
initial_condition = initial_condition,
boundary_conditions = boundary_conditions,
source_terms = source_terms,
mesh = mesh,
deactivated_subdomains = deactivated_subdomains,
is_subclass = FALSE,
attr_names = character(),
flatten_on_exp = character()
),
class = "r2ogs6_process_variable"
)
}
#===== r2ogs6_boundary_condition =====
#'r2ogs6_boundary_condition
#'@description tag: boundary_condition
#'@param type string:
#'@param parameter string:
#'@param geometrical_set Optional: string:
#'@param geometry Optional: string:
#'@param component Optional: string | double:
#'@param mesh Optional: string:
#'@param alpha Optional: string:
#'@param u_0 Optional: string:
#'@param constraint_type Optional: string:
#'@param constraining_process_variable Optional: string:
#'@param constraint_threshold Optional: string | double:
#'@param constraint_direction Optional: string:
#'@param area_parameter Optional: string:
#'@param bc_object Optional: string:
#'@param flush_stdout Optional: string:
#'@param property_name Optional: string:
#'@param initial_value_parameter Optional: string:
#'@param constant_name Optional: string:
#'@param coefficient_current_variable_name Optional: string:
#'@param coefficient_other_variable_name Optional: string:
#'@param coefficient_mixed_variables_name Optional: string:
#'@param threshold_parameter Optional: string:
#'@param comparison_operator Optional: string:
#'@param time_interval Optional: list of 2, character:
#'@export
r2ogs6_boundary_condition <- function(type,
parameter = NULL,
geometrical_set = NULL,
geometry = NULL,
component = NULL,
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){
component <- coerce_string_to_numeric(component)
constraint_threshold <- coerce_string_to_numeric(constraint_threshold)
new_r2ogs6_boundary_condition(type,
parameter,
geometrical_set,
geometry,
component,
mesh,
alpha,
u_0,
constraint_type,
constraining_process_variable,
constraint_threshold,
constraint_direction,
area_parameter,
bc_object,
flush_stdout,
property_name,
initial_value_parameter,
constant_name,
coefficient_current_variable_name,
coefficient_other_variable_name,
coefficient_mixed_variables_name,
threshold_parameter,
comparison_operator,
time_interval)
}
new_r2ogs6_boundary_condition <- function(type,
parameter = NULL,
geometrical_set = NULL,
geometry = NULL,
component = NULL,
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){
assertthat::assert_that(assertthat::is.string(type))
validate_is_null_or_number(component,
constraint_threshold)
validate_is_null_or_string(parameter,
geometrical_set,
geometry,
mesh,
alpha,
u_0,
constraint_type,
constraining_process_variable,
constraint_direction,
area_parameter,
bc_object,
property_name,
initial_value_parameter,
constant_name,
coefficient_current_variable_name,
coefficient_other_variable_name,
coefficient_mixed_variables_name,
threshold_parameter,
comparison_operator)
validate_is_null_or_str_flag(flush_stdout)
time_interval <- validate_time_interval(time_interval,
is_optional = TRUE)
structure(list(type = type,
parameter = parameter,
geometrical_set = geometrical_set,
component = component,
mesh = mesh,
alpha = alpha,
u_0 = u_0,
constraint_type = constraint_type,
constraining_process_variable =
constraining_process_variable,
constraint_threshold = constraint_threshold,
constraint_direction = constraint_direction,
area_parameter = area_parameter,
bc_object = bc_object,
flush_stdout = flush_stdout,
property_name = property_name,
initial_value_parameter = initial_value_parameter,
constant_name = constant_name,
coefficient_current_variable_name =
coefficient_current_variable_name,
coefficient_other_variable_name =
coefficient_other_variable_name,
coefficient_mixed_variables_name =
coefficient_mixed_variables_name,
threshold_parameter = threshold_parameter,
comparison_operator = comparison_operator,
time_interval = time_interval,
is_subclass = TRUE,
attr_names = character(),
flatten_on_exp = character()
),
class = "r2ogs6_boundary_condition"
)
}
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
#===== r2ogs6_source_term =====
#'r2ogs6_source_term
#'@description tag: source_term
#'@param type string:
#'@param parameter Optional: string:
#'@param geometrical_set Optional: string:
#'@param geometry Optional: string:
#'@param mesh Optional: string:
#'@param source_term_object Optional: string:
#'@export
r2ogs6_source_term <- function(type,
parameter = NULL,
geometrical_set = NULL,
geometry = NULL,
mesh = NULL,
source_term_object = NULL){
#Coerce input
new_r2ogs6_source_term(type,
parameter,
geometrical_set,
geometry,
mesh,
source_term_object)
}
new_r2ogs6_source_term <- function(type,
parameter = NULL,
geometrical_set = NULL,
geometry = NULL,
mesh = NULL,
source_term_object = NULL){
assertthat::assert_that(assertthat::is.string(type))
validate_is_null_or_string(parameter,
geometrical_set,
geometry,
mesh,
source_term_object)
structure(list(type = type,
parameter = parameter,
geometrical_set = geometrical_set,
geometry = geometry,
mesh = mesh,
source_term_object = source_term_object,
is_subclass = TRUE,
attr_names = character(),
flatten_on_exp = character()
),
class = "r2ogs6_source_term"
)
}
#===== r2ogs6_deactivated_subdomain =====
#'r2ogs6_deactivated_subdomain
#'@description tag: deactivated_subdomain
#'@param time_interval list, numeric:
#'@param material_ids string | double:
#'@export
r2ogs6_deactivated_subdomain <- function(time_interval,
material_ids){
#Coerce input
material_ids <- coerce_string_to_numeric(material_ids)
new_r2ogs6_deactivated_subdomain(time_interval,
material_ids)
}
new_r2ogs6_deactivated_subdomain <- function(time_interval,
material_ids){
time_interval <- validate_time_interval(time_interval)
assertthat::assert_that(assertthat::is.number(material_ids))
structure(list(time_interval = time_interval,
material_ids = material_ids,
is_subclass = TRUE,
attr_names = character(),
flatten_on_exp = character()
),
class = "r2ogs6_deactivated_subdomain"
)
}
#===== time_interval =====
validate_time_interval <- function(time_interval,
is_optional = FALSE){
if(is_optional && is.null(time_interval)){
return(invisible(time_interval))
}
assertthat::assert_that(is.list(time_interval))
for(i in seq_len(length(time_interval))){
time_interval[[i]] <-
validate_param_list(time_interval[[i]],
c("start", "end"))
}
return(invisible(time_interval))
}