File boutmesh.cxx#

Defines

PVEC_REAL_MPI_TYPE#

MPI type of BoutReal for communications.

Variables

const int IN_SENT_UP = 0#

Data lower in X than branch-cut, at upper boundary in Y.

const int OUT_SENT_UP = 1#

Data higher in X than branch-cut, at upper boundary in Y.

const int IN_SENT_DOWN = 2#

Data lower in X than branch-cut, at lower boundary in Y.

const int OUT_SENT_DOWN = 3#

Data higher in X than branch-cut, at lower boundary in Y.

const int IN_SENT_OUT = 4#

Data going in positive X direction (in to out)

const int OUT_SENT_IN = 5#

Data going in negative X direction (out to in)

namespace bout

Provides access to the Hypre library, handling initialisation and finalisation.

Usage

#include <bout/hyprelib.hxx>

class MyClass { public:

private: HypreLib lib; };

This will then automatically initialise Hypre the first time an object is created, and finalise it when the last object is destroyed.

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

Information about the version of BOUT++

The build system will update this file on every commit, which may result in files that include it getting rebuilt. Therefore it should be included in as few places as possible

Information about the version of BOUT++

The build system will update this file at configure-time

SNB model

Functions

CheckMeshResult checkBoutMeshYDecomposition(int num_y_processors, int ny, int num_y_guards, int jyseps1_1, int jyseps2_1, int jyseps1_2, int jyseps2_2, int ny_inner)#

Check that total_processors can be decomposed into num_y_processors in Y for the given BoutMesh topology parameters