xref: /petsc/src/mat/impls/transpose/transm.c (revision 487a658c8b32ba712a1dc8280daad2fd70c1dcd9)
1 
2 #include <petsc/private/matimpl.h>          /*I "petscmat.h" I*/
3 
4 typedef struct {
5   Mat A;
6 } Mat_Transpose;
7 
8 PetscErrorCode MatMult_Transpose(Mat N,Vec x,Vec y)
9 {
10   Mat_Transpose  *Na = (Mat_Transpose*)N->data;
11   PetscErrorCode ierr;
12 
13   PetscFunctionBegin;
14   ierr = MatMultTranspose(Na->A,x,y);CHKERRQ(ierr);
15   PetscFunctionReturn(0);
16 }
17 
18 PetscErrorCode MatMultAdd_Transpose(Mat N,Vec v1,Vec v2,Vec v3)
19 {
20   Mat_Transpose  *Na = (Mat_Transpose*)N->data;
21   PetscErrorCode ierr;
22 
23   PetscFunctionBegin;
24   ierr = MatMultTransposeAdd(Na->A,v1,v2,v3);CHKERRQ(ierr);
25   PetscFunctionReturn(0);
26 }
27 
28 PetscErrorCode MatMultTranspose_Transpose(Mat N,Vec x,Vec y)
29 {
30   Mat_Transpose  *Na = (Mat_Transpose*)N->data;
31   PetscErrorCode ierr;
32 
33   PetscFunctionBegin;
34   ierr = MatMult(Na->A,x,y);CHKERRQ(ierr);
35   PetscFunctionReturn(0);
36 }
37 
38 PetscErrorCode MatMultTransposeAdd_Transpose(Mat N,Vec v1,Vec v2,Vec v3)
39 {
40   Mat_Transpose  *Na = (Mat_Transpose*)N->data;
41   PetscErrorCode ierr;
42 
43   PetscFunctionBegin;
44   ierr = MatMultAdd(Na->A,v1,v2,v3);CHKERRQ(ierr);
45   PetscFunctionReturn(0);
46 }
47 
48 PetscErrorCode MatDestroy_Transpose(Mat N)
49 {
50   Mat_Transpose  *Na = (Mat_Transpose*)N->data;
51   PetscErrorCode ierr;
52 
53   PetscFunctionBegin;
54   ierr = MatDestroy(&Na->A);CHKERRQ(ierr);
55   ierr = PetscObjectComposeFunction((PetscObject)N,"MatTransposeGetMat_C",NULL);CHKERRQ(ierr);
56   ierr = PetscFree(N->data);CHKERRQ(ierr);
57   PetscFunctionReturn(0);
58 }
59 
60 PetscErrorCode MatDuplicate_Transpose(Mat N, MatDuplicateOption op, Mat* m)
61 {
62   Mat_Transpose  *Na = (Mat_Transpose*)N->data;
63   PetscErrorCode ierr;
64 
65   PetscFunctionBegin;
66   if (op == MAT_COPY_VALUES) {
67     ierr = MatTranspose(Na->A,MAT_INITIAL_MATRIX,m);CHKERRQ(ierr);
68   } else if (op == MAT_DO_NOT_COPY_VALUES) {
69     ierr = MatDuplicate(Na->A,MAT_DO_NOT_COPY_VALUES,m);CHKERRQ(ierr);
70     ierr = MatTranspose(*m,MAT_INPLACE_MATRIX,m);CHKERRQ(ierr);
71   } else SETERRQ(PetscObjectComm((PetscObject)N),PETSC_ERR_SUP,"MAT_SHARE_NONZERO_PATTERN not supported for this matrix type");
72   PetscFunctionReturn(0);
73 }
74 
75 PetscErrorCode MatTransposeGetMat_Transpose(Mat A,Mat *M)
76 {
77   Mat_Transpose  *Aa = (Mat_Transpose*)A->data;
78 
79   PetscFunctionBegin;
80   *M = Aa->A;
81   PetscFunctionReturn(0);
82 }
83 
84 /*@
85       MatTransposeGetMat - Gets the Mat object stored inside a MATTRANSPOSEMAT'
86 
87    Logically collective on Mat
88 
89    Input Parameter:
90 .   A  - the MATTRANSPOSE matrix
91 
92    Output Parameter:
93 .   M - the matrix object stored inside A
94 
95    Level: intermediate
96 
97 .seealso: MatCreateTranspose()
98 
99 @*/
100 PetscErrorCode MatTransposeGetMat(Mat A,Mat *M)
101 {
102   PetscErrorCode ierr;
103 
104   PetscFunctionBegin;
105   PetscValidHeaderSpecific(A,MAT_CLASSID,1);
106   PetscValidType(A,1);
107   PetscValidPointer(M,2);
108   ierr = PetscUseMethod(A,"MatTransposeGetMat_C",(Mat,Mat*),(A,M));CHKERRQ(ierr);
109   PetscFunctionReturn(0);
110 }
111 
112 /*@
113       MatCreateTranspose - Creates a new matrix object that behaves like A'
114 
115    Collective on Mat
116 
117    Input Parameter:
118 .   A  - the (possibly rectangular) matrix
119 
120    Output Parameter:
121 .   N - the matrix that represents A'
122 
123    Level: intermediate
124 
125    Notes:
126     The transpose A' is NOT actually formed! Rather the new matrix
127           object performs the matrix-vector product by using the MatMultTranspose() on
128           the original matrix
129 
130 .seealso: MatCreateNormal(), MatMult(), MatMultTranspose(), MatCreate()
131 
132 @*/
133 PetscErrorCode  MatCreateTranspose(Mat A,Mat *N)
134 {
135   PetscErrorCode ierr;
136   PetscInt       m,n;
137   Mat_Transpose  *Na;
138 
139   PetscFunctionBegin;
140   ierr = MatGetLocalSize(A,&m,&n);CHKERRQ(ierr);
141   ierr = MatCreate(PetscObjectComm((PetscObject)A),N);CHKERRQ(ierr);
142   ierr = MatSetSizes(*N,n,m,PETSC_DECIDE,PETSC_DECIDE);CHKERRQ(ierr);
143   ierr = PetscLayoutSetUp((*N)->rmap);CHKERRQ(ierr);
144   ierr = PetscLayoutSetUp((*N)->cmap);CHKERRQ(ierr);
145   ierr = PetscObjectChangeTypeName((PetscObject)*N,MATTRANSPOSEMAT);CHKERRQ(ierr);
146 
147   ierr       = PetscNewLog(*N,&Na);CHKERRQ(ierr);
148   (*N)->data = (void*) Na;
149   ierr       = PetscObjectReference((PetscObject)A);CHKERRQ(ierr);
150   Na->A      = A;
151 
152   (*N)->ops->destroy          = MatDestroy_Transpose;
153   (*N)->ops->mult             = MatMult_Transpose;
154   (*N)->ops->multadd          = MatMultAdd_Transpose;
155   (*N)->ops->multtranspose    = MatMultTranspose_Transpose;
156   (*N)->ops->multtransposeadd = MatMultTransposeAdd_Transpose;
157   (*N)->ops->duplicate        = MatDuplicate_Transpose;
158   (*N)->assembled             = PETSC_TRUE;
159 
160   ierr = PetscObjectComposeFunction((PetscObject)(*N),"MatTransposeGetMat_C",MatTransposeGetMat_Transpose);CHKERRQ(ierr);
161   ierr = MatSetBlockSizes(*N,PetscAbs(A->cmap->bs),PetscAbs(A->rmap->bs));CHKERRQ(ierr);
162   ierr = MatSetUp(*N);CHKERRQ(ierr);
163   PetscFunctionReturn(0);
164 }
165 
166