.TH "MAGNETICFOAM" 1 "OpenFOAM-" "www.openfoam.com" "OpenFOAM Commands Manual"
.SH "NAME"
magneticFoam \- part of \fBOpenFOAM\fR (The Open Source CFD Toolbox).
.SH "SYNOPSIS"
\fBmagneticFoam\fR [\fIOPTIONS\fR]
.SH "DESCRIPTION"
.nf
Solver for the magnetic field generated by permanent magnets.
.fi
.SH "OPTIONS"
.TP
\fB\-HdotGradH\fR
Write the paramagnetic particle force field
.TP
\fB\-case\fR \fIdir\fR
Specify case directory to use (instead of the cwd)
.TP
\fB\-decomposeParDict\fR \fIfile\fR
Use specified file for decomposePar dictionary
.TP
\fB\-dry-run\fR
Check case set-up only using a single time step
.TP
\fB\-dry-run-write\fR
Check case set-up and write only using a single time step
.TP
\fB\-noB\fR
Do not write the magnetic flux density field
.TP
\fB\-noH\fR
Do not write the magnetic field intensity field
.TP
\fB\-parallel\fR
Run in parallel
\fB[Parallel option]\fR
.TP
\fB\-doc\fR
Display documentation in browser
.TP
\fB\-help\fR
Display short help and exit
.TP
\fB\-help-full\fR
Display full help and exit
.SS "ADVANCED OPTIONS"
.TP
\fB\-debug-switch\fR \fIname=val\fR
Specify the value of a registered debug switch. Default is 1 if the value is
omitted. (Can be used multiple times)
.TP
\fB\-fileHandler\fR \fIhandler\fR
Override the file handler type
.TP
\fB\-hostRoots\fR \fI((host1 dir1) .. (hostN dirN))\fR
Per-host slave root directories for distributed running. The host specification
can be a regex.
\fB[Parallel option]\fR
.TP
\fB\-info-switch\fR \fIname=val\fR
Specify the value of a registered info switch. Default is 1 if the value is
omitted. (Can be used multiple times)
.TP
\fB\-lib\fR \fIname\fR
Additional library or library list to load (can be used multiple times)
.TP
\fB\-listFunctionObjects\fR
List functionObjects
.TP
\fB\-listRegisteredSwitches\fR
List switches registered for run-time modification (see -listUnsetSwitches
option)
.TP
\fB\-listScalarBCs\fR
List scalar field boundary conditions (fvPatchField<scalar>)
.TP
\fB\-listSwitches\fR
List switches declared in libraries (see -listUnsetSwitches option)
.TP
\fB\-listUnsetSwitches\fR
Modifies switch listing to display values not set in etc/controlDict
.TP
\fB\-listVectorBCs\fR
List vector field boundary conditions (fvPatchField<vector>)
.TP
\fB\-noFunctionObjects\fR
Do not execute function objects
.TP
\fB\-opt-switch\fR \fIname=val\fR
Specify the value of a registered optimisation switch (int/bool). Default is 1
if the value is omitted. (Can be used multiple times)
.TP
\fB\-roots\fR \fI(dir1 .. dirN)\fR
Slave root directories for distributed running
\fB[Parallel option]\fR
.TP
\fB\-doc-source\fR
Display source code in browser
.TP
\fB\-help-man\fR
Display full help (manpage format) and exit
.TP
\fB\-help-notes\fR
Display help notes (description) and exit
.SH "SEE ALSO"
Online documentation https://www.openfoam.com/documentation/
.SH COPYRIGHT
Copyright \(co 2018-2019 OpenCFD Ltd.