File field_data.hxx

Class inherited by any field wanting to use Communicator or Solver objects.

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/.

Defines

__FIELD_DATA_H__
class FieldData
#include <field_data.hxx>

Interface used to access data in field classes.

Used by communicator, solver and (soon) datafile classes to access internal data in a general way

Subclassed by Field2D, Field3D, Vector2D, Vector3D

Public Functions

FieldData()
~FieldData()
virtual void accept(FieldVisitor &v) = 0
virtual bool isReal() const = 0

Returns true if field consists of BoutReal values.

virtual bool is3D() const = 0

True if variable is 3D.

virtual int byteSize() const = 0

Number of bytes for a single point.

virtual int BoutRealSize() const

Number of BoutReals (not implemented if not BoutReal)

virtual void doneComms()
void setBoundary(const std::string &name)

Set the boundary conditions.

void copyBoundary(const FieldData &f)

Copy the boundary conditions from another field.

virtual void applyBoundary(bool init = false)
virtual void applyTDerivBoundary()
void addBndryFunction(FuncPtr userfunc, BndryLoc location)
void addBndryGenerator(FieldGeneratorPtr gen, BndryLoc location)
FieldGeneratorPtr getBndryGenerator(BndryLoc location)

Protected Attributes

std::vector<BoundaryOp *> bndry_op

Boundary conditions.

bool boundaryIsCopy = {false}

True if bndry_op is a copy.

bool boundaryIsSet = {false}

Set to true when setBoundary called.

std::vector<BoundaryOpPar *> bndry_op_par

Boundary conditions.

std::map<BndryLoc, FieldGeneratorPtr> bndry_generator