Xpetra Version of the Day
Loading...
Searching...
No Matches
Xpetra::MatrixFactory::Xpetra Namespace Reference

Xpetra namespace More...

Classes

class  firstArg
class  secondArg
class  Array
class  ArrayRCP
class  ArrayView
class  Comm
struct  OrdinalTraits
class  RCP
struct  ScalarTraits
class  ParameterList

Typedefs

typedef Teuchos_Ordinal Array_size_type
 Size type for Teuchos Array objects.
typedef size_t global_size_t
 Global size_t object.

Enumerations

enum  LocalGlobal { LocallyReplicated , GloballyDistributed }
enum  LookupStatus { AllIDsPresent , IDNotPresent }
enum  OptimizeOption { DoOptimizeStorage , DoNotOptimizeStorage }
enum  CombineMode { ADD , INSERT , ABSMAX }
 Xpetra::Combine Mode enumerable type. More...

Functions

TEUCHOS_DEPRECATED RCP< T > rcp (T *p, Dealloc_T dealloc, bool owns_mem)
std::string typeName (const T &t)

Detailed Description

Xpetra namespace

Namespace for Xpetra classes and methods.

Typedef Documentation

◆ Array_size_type

Size type for Teuchos Array objects.

Definition at line 64 of file Xpetra_MatrixFactory_decl.hpp.

◆ global_size_t

Global size_t object.

Set at configure time, this type is intended to support scenarios where the global memory allocation is larger than that of a single node.

Currently, it is typedefed to size_t.

Definition at line 139 of file Xpetra_MatrixFactory_decl.hpp.

Enumeration Type Documentation

◆ LocalGlobal

Local versus global allocation of Map elements

Enumerator
LocallyReplicated 

Indicates that map elements are locally replicated across all nodes

GloballyDistributed 

Indicates that map elements are globally distributed across all nodes

Definition at line 142 of file Xpetra_MatrixFactory_decl.hpp.

◆ LookupStatus

Return status of Map lookup

Enumerator
AllIDsPresent 

Indicates that all queried IDs were present in the Map

IDNotPresent 

Indicates that at least one of the specified IDs was not present in the Map

Definition at line 148 of file Xpetra_MatrixFactory_decl.hpp.

◆ OptimizeOption

Optimize storage option

Enumerator
DoOptimizeStorage 

Indicates that storage should be optimized

DoNotOptimizeStorage 

Indicates that storage should not be optimized

Definition at line 154 of file Xpetra_MatrixFactory_decl.hpp.

◆ CombineMode

Xpetra::Combine Mode enumerable type.

If set to Add, existing values will be summed with new values. If set to Insert, new values will be inserted that don't currently exist. If set to Replace, existing values will be replaced with new values.

NOTE: Add and Replace are intended for modifying values that already exist, but it will function correctly if those values don't already exist. (i.e. zero will be inserted, and then summed with or replaced by the new value.) However, performance may suffer. (The same goes for Insert.)

Enumerator
ADD 

Existing values will be summed with new values.

INSERT 

Insert new values that don't currently exist.

ABSMAX 

TODO: don't exist for Tpetra

Definition at line 177 of file Xpetra_MatrixFactory_decl.hpp.

Function Documentation

◆ rcp()

TEUCHOS_DEPRECATED RCP< T > Teuchos::rcp ( T * p,
Dealloc_T dealloc,
bool owns_mem )

◆ typeName()

std::string Teuchos::typeName ( const T & t)