File vecops.hxx#
Operators on vector objects B.Dudson, October 2007
Copyright 2010 B.D.Dudson, S.Farley, M.V.Umansky, X.Q.Xu
Contact: Ben Dudson, bd512@york.ac.uk
This file is part of BOUT++.
BOUT++ is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
BOUT++ is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License along with BOUT++. If not, see http://www.gnu.org/licenses/.
Functions
-
Vector2D Grad(const Field2D &f, CELL_LOC outloc = CELL_DEFAULT, const std::string &method = "DEFAULT")
Gradient of scalar field
f
, returning a covariant vectorAll locations supported
- Parameters:
f – [in] The field to differentiate
outloc – [in] The location where the result is desired By default this is the same location as the input
f
method – [in] The method to use. The default is set in the options.
-
Vector3D Grad(const Field3D &f, CELL_LOC outloc = CELL_DEFAULT, const std::string &method = "DEFAULT")
-
Vector3D Grad_perp(const Field3D &f, CELL_LOC outloc = CELL_DEFAULT, const std::string &method = "DEFAULT")
Perpendicular gradient of scalar field
f
outloc must be either CELL_DEFAULT or f.getLocation() —> argument can be removed
result.x = df/dx - g_12/(JB)^2 df/dy result.y = 0 result.z = df/dz - g_23/(JB)^2 df/dy
- Parameters:
f – [in] The field to differentiate
outloc – [in] The cell location where the result is desired
method – [in] The method to use. The default is set in the options.
-
inline Vector3D Grad_perp(const Field3D &f, CELL_LOC outloc, DIFF_METHOD method)#
-
Vector2D Grad_perp(const Field2D &f, CELL_LOC outloc = CELL_DEFAULT, const std::string &method = "DEFAULT")
-
Coordinates::FieldMetric Div(const Vector2D &v, CELL_LOC outloc = CELL_DEFAULT, const std::string &method = "DEFAULT")
Divergence of a vector
v
, returning a scalarAll locations except
CELL_VSHIFT
supported. Note that ifv
is atCELL_VSHIFT
, thenoutloc
must beCELL_CENTRE
- Parameters:
v – [in] The vector to differentiate
outloc – [in] The cell location where the result is desired
method – [in] The method to use. The default is set in the options.
-
Field3D Div(const Vector3D &v, CELL_LOC outloc = CELL_DEFAULT, const std::string &method = "DEFAULT")
-
Coordinates::FieldMetric Div(const Vector2D &v, const Field2D &f, CELL_LOC outloc = CELL_DEFAULT, const std::string &method = "DEFAULT")
-
Field3D Div(const Vector3D &v, const Field3D &f, CELL_LOC outloc = CELL_DEFAULT, const std::string &method = "DEFAULT")
-
inline Field3D Div(const Vector3D &v, const Field3D &f, CELL_LOC outloc, DIFF_METHOD method = DIFF_DEFAULT)#
-
Vector2D Curl(const Vector2D &v)
Curl of a vector
Does not currently support any output locations.
v
must not be atCELL_VSHIFT
We can’t support VSHIFT here as, e.g. DDY can’t produce an output at CELL_XLOW unless the input field is at CELL_XLOW, but then that field will also be needed at CELL_YLOW, for example for another component.
- Parameters:
v – [in] The vector to differentiate
-
Coordinates::FieldMetric V_dot_Grad(const Vector2D &v, const Field2D &f)
Advection of a scalar field
f
by a velocity vectorv
The vector and the field must be at the same location, which cannot be CELL_VSHIFT