Skip to main content
Ctrl+K

BOUT++ 5.1.0 documentation

Getting started

  • Introduction
  • Quickstart Guide
  • Getting started
  • Advanced installation options
  • Running BOUT++
  • New Features in BOUT++ v5.0

BOUT++ models

  • BOUT++ physics models
  • Makefiles and compiling BOUT++
  • Variable initialisation
  • Boundary conditions
  • Testing
  • GPU support
  • ADIOS2 support

Model inputs

  • BOUT++ options
  • Generating input grids

Model outputs

  • Post-processing
  • The python boutpp module

BOUT++ interfaces

  • Time integration
  • Parallel Transforms
  • Laplacian inversion
  • Differential operators
  • Algebraic operators
  • Staggered grids
  • Eigenvalue solver
  • Nonlocal heat flux models
  • Invertable operators
  • PETSc solvers

Field-aligned coordinate systems

  • Field-aligned coordinates
  • BOUT++ preconditioning
  • Geometry and Differential Operator

Developer Documentation

  • Contributing to BOUT++
  • Git crash course
  • Code layout
  • Arrays, scalar and vector field types
  • PETSc interface
  • Mesh
  • File I/O
  • Natural Language Support
  • Performance profiling
  • API reference
    • BOUT++ functions (alphabetical)
    • File list
      • File adams_bashforth.cxx
      • File adams_bashforth.hxx
      • File adios_object.cxx
      • File adios_object.hxx
      • File arkode.cxx
      • File arkode.hxx
      • File array.hxx
      • File assert.hxx
      • File bilinear_xz.cxx
      • File boundary_factory.cxx
      • File boundary_factory.hxx
      • File boundary_op.hxx
      • File boundary_region.cxx
      • File boundary_region.hxx
      • File boundary_standard.cxx
      • File boundary_standard.hxx
      • File bout++-time.cxx
      • File bout++-time.hxx
      • File bout++.cxx
      • File bout.hxx
      • File bout_enum_class.hxx
      • File bout_types.cxx
      • File bout_types.hxx
      • File boutcomm.cxx
      • File boutcomm.hxx
      • File boutexception.cxx
      • File boutexception.hxx
      • File boutmesh.cxx
      • File boutmesh.hxx
      • File build_config.hxx
      • File build_defines.hxx
      • File caliper_wrapper.hxx
      • File cashkarp.cxx
      • File cashkarp.hxx
      • File constants.hxx
      • File coordinates.cxx
      • File coordinates.hxx
      • File coordinates_accessor.cxx
      • File coordinates_accessor.hxx
      • File cvode.cxx
      • File cvode.hxx
      • File cyclic.cxx
      • File cyclic.hxx
      • File cyclic_laplace.cxx
      • File cyclic_laplace.hxx
      • File cyclic_reduction.hxx
      • File dcomplex.hxx
      • File deriv_store.hxx
      • File derivs.cxx
      • File derivs.hxx
      • File difops.cxx
      • File difops.hxx
      • File euler.cxx
      • File euler.hxx
      • File expr.hxx
      • File expressionparser.cxx
      • File expressionparser.hxx
      • File fci.cxx
      • File fci.hxx
      • File fft.hxx
      • File fft_fftw.cxx
      • File field2d.cxx
      • File field2d.hxx
      • File field3d.cxx
      • File field3d.hxx
      • File field.cxx
      • File field.hxx
      • File field_accessor.hxx
      • File field_data.cxx
      • File field_data.hxx
      • File field_factory.cxx
      • File field_factory.hxx
      • File fieldgenerators.cxx
      • File fieldgenerators.hxx
      • File fieldgroup.cxx
      • File fieldgroup.hxx
      • File fieldperp.cxx
      • File fieldperp.hxx
      • File fv_ops.cxx
      • File fv_ops.hxx
      • File gen_fieldops.py
      • File generated_fieldops.cxx
      • File generator_context.cxx
      • File generator_context.hxx
      • File generic_factory.hxx
      • File gettext.hxx
      • File globalfield.cxx
      • File globalfield.hxx
      • File globalindexer.hxx
      • File globals.hxx
      • File griddata.hxx
      • File gridfromfile.cxx
      • File gridfromoptions.cxx
      • File gyro_average.cxx
      • File gyro_average.hxx
      • File hermite_spline_xz.cxx
      • File hermite_spline_z.cxx
      • File hypre3d_laplace.cxx
      • File hypre3d_laplace.hxx
      • File hypre_interface.hxx
      • File hyprelib.cxx
      • File hyprelib.hxx
      • File ida.cxx
      • File ida.hxx
      • File identity.cxx
      • File imex-bdf2.cxx
      • File imex-bdf2.hxx
      • File index_derivs.cxx
      • File index_derivs.hxx
      • File index_derivs_interface.hxx
      • File initialprofiles.cxx
      • File initialprofiles.hxx
      • File interpolation.hxx
      • File interpolation_xz.cxx
      • File interpolation_xz.hxx
      • File interpolation_z.cxx
      • File interpolation_z.hxx
      • File invert_laplace.cxx
      • File invert_laplace.hxx
      • File invert_parderiv.cxx
      • File invert_parderiv.hxx
      • File invert_pardiv.cxx
      • File invert_pardiv.hxx
      • File invertable_operator.hxx
      • File iterative_parallel_tri.cxx
      • File iterative_parallel_tri.hxx
      • File lagrange_4pt_xz.cxx
      • File lapack_routines.cxx
      • File lapack_routines.hxx
      • File laplacexy2.cxx
      • File laplacexy2.hxx
      • File laplacexy2_hypre.cxx
      • File laplacexy2_hypre.hxx
      • File laplacexy.cxx
      • File laplacexy.hxx
      • File laplacexz-cyclic.cxx
      • File laplacexz-cyclic.hxx
      • File laplacexz-petsc.cxx
      • File laplacexz-petsc.hxx
      • File laplacexz.cxx
      • File laplacexz.hxx
      • File macro_for_each.hxx
      • File mask.hxx
      • File mesh.cxx
      • File mesh.hxx
      • File monitor.hxx
      • File monotonic_hermite_spline_xz.cxx
      • File mpi_wrapper.hxx
      • File msg_stack.cxx
      • File msg_stack.hxx
      • File multigrid_alg.cxx
      • File multigrid_laplace.cxx
      • File multigrid_laplace.hxx
      • File multigrid_solver.cxx
      • File multiostream.hxx
      • File naulin_laplace.cxx
      • File naulin_laplace.hxx
      • File openmpwrap.hxx
      • File operatorstencil.hxx
      • File optionparser.hxx
      • File options.cxx
      • File options.hxx
      • File options_adios.cxx
      • File options_adios.hxx
      • File options_ini.cxx
      • File options_ini.hxx
      • File options_io.cxx
      • File options_io.hxx
      • File options_netcdf.cxx
      • File options_netcdf.hxx
      • File optionsreader.cxx
      • File optionsreader.hxx
      • File output.cxx
      • File output.hxx
      • File output_bout_types.hxx
      • File parallel_boundary_op.cxx
      • File parallel_boundary_op.hxx
      • File parallel_boundary_region.cxx
      • File parallel_boundary_region.hxx
      • File parallel_boundary_stencil.cxx.py
      • File paralleltransform.hxx
      • File pardiv_cyclic.cxx
      • File pardiv_cyclic.hxx
      • File pcr.cxx
      • File pcr.hxx
      • File pcr_thomas.cxx
      • File pcr_thomas.hxx
      • File petsc3damg.cxx
      • File petsc3damg.hxx
      • File petsc.cxx
      • File petsc.hxx
      • File petsc_interface.hxx
      • File petsc_laplace.cxx
      • File petsc_laplace.hxx
      • File petsclib.cxx
      • File petsclib.hxx
      • File physicsmodel.cxx
      • File physicsmodel.hxx
      • File power.cxx
      • File power.hxx
      • File pvode.cxx
      • File pvode.hxx
      • File rajalib.hxx
      • File range.cxx
      • File range.hxx
      • File region.hxx
      • File revision.hxx
      • File rk3-ssp.cxx
      • File rk3-ssp.hxx
      • File rk4.cxx
      • File rk4.hxx
      • File rk4simple.cxx
      • File rk4simple.hxx
      • File rkf34.cxx
      • File rkf34.hxx
      • File rkf45.cxx
      • File rkf45.hxx
      • File rkgeneric.cxx
      • File rkgeneric.hxx
      • File rkscheme.cxx
      • File rkscheme.hxx
      • File rvec.hxx
      • File scorepwrapper.hxx
      • File serial_band.cxx
      • File serial_band.hxx
      • File serial_tri.cxx
      • File serial_tri.hxx
      • File shiftedmetric.cxx
      • File shiftedmetricinterp.cxx
      • File shiftedmetricinterp.hxx
      • File single_index_ops.hxx
      • File slepc.cxx
      • File slepc.hxx
      • File slepclib.cxx
      • File slepclib.hxx
      • File smoothing.cxx
      • File smoothing.hxx
      • File snb.cxx
      • File snb.hxx
      • File snes.cxx
      • File snes.hxx
      • File solver.cxx
      • File solver.hxx
      • File solverfactory.hxx
      • File sourcex.cxx
      • File sourcex.hxx
      • File split-rk.cxx
      • File split-rk.hxx
      • File spt.cxx
      • File spt.hxx
      • File stencils.hxx
      • File stencils_sympy.py
      • File sundials_backports.hxx
      • File surfaceiter.cxx
      • File surfaceiter.hxx
      • File template_combinations.hxx
      • File timer.cxx
      • File timer.hxx
      • File traits.hxx
      • File type_name.cxx
      • File type_name.hxx
      • File uncopyable.hxx
      • File unused.hxx
      • File utils.cxx
      • File utils.hxx
      • File uuid.h
      • File variant.hxx
      • File vecops.cxx
      • File vecops.hxx
      • File vector2d.cxx
      • File vector2d.hxx
      • File vector3d.cxx
      • File vector3d.hxx
      • File vectormetric.hxx
      • File version.hxx
      • File where.cxx
      • File where.hxx
    • Python routines
    • boutdata package
    • boutpp package
    • boututils package
    • zoidberg package
  • Repository
  • Suggest edit
  • Open issue
  • .rst

File field_factory.cxx

File field_factory.cxx#

Functions

FieldGeneratorPtr generator(BoutReal value)#

Helper function to create a FieldValue generator from a BoutReal.

FieldGeneratorPtr generator(BoutReal *ptr)#

Helper function to create a FieldValuePtr from a pointer to BoutReal.

previous

File field_data.hxx

next

File field_factory.hxx

By B. Dudson and The BOUT++ team

© Copyright 2017-2023, B. Dudson and The BOUT++ team.