Skip to content
Snippets Groups Projects
prj_output.Rd 1.2 KiB
Newer Older
  • Learn to ignore specific revisions
  • % Generated by roxygen2: do not edit by hand
    % Please edit documentation in R/prj_time_loop.R
    \name{prj_output}
    \alias{prj_output}
    \title{prj_output}
    \usage{
    prj_output(
      type,
      prefix,
      variables,
      suffix = NULL,
      timesteps = NULL,
      compress_output = NULL,
      data_mode = NULL,
      output_iteration_results = NULL,
      meshes = NULL,
    
      fixed_output_times = NULL,
      hdf = NULL
    
    )
    }
    \arguments{
    \item{type}{string:}
    
    \item{prefix}{string:}
    
    \item{variables}{vector:}
    
    \item{suffix}{Optional: string:}
    
    \item{timesteps}{Optional:}
    
    \item{compress_output}{Optional: string: Should the output be compressed?
    Either "true" or "false"}
    
    \item{data_mode}{Optional: string:}
    
    \item{output_iteration_results}{Optional: string: Either "true" or "false"}
    
    \item{meshes}{Optional: character: A vector of mesh names}
    
    \item{fixed_output_times}{Optional: string | numeric:}
    
    
    \item{hdf}{Optional: numeric}
    
    }
    \description{
    tag: output
    }
    \examples{
    prj_output(
        type = "VTK",
        prefix = "flow_free_expansion",
        variables = list(
            variable = "displacement",
            variable = "pressure"
        ),
        suffix = "_ts_{:timestep}_t_{:time}",
        timesteps = list(pair = list(1,
                                     each_steps = 1000))
    )
    }